Class: Aws::SNS::Subscription

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

#initialize(arn, options = {}) ⇒ Subscription #initialize(options = {}) ⇒ Subscription

Returns a new instance of Subscription.

Overloads:

  • #initialize(arn, options = {}) ⇒ Subscription

    Parameters:

    • arn (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Subscription

    Options Hash (options):

    • :arn (required, String)
    • :client (Client)


22
23
24
25
26
27
28
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @arn = extract_arn(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#arnString

Returns:

  • (String)


33
34
35
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 33

def arn
  @arn
end

#attributesHash<String,String>

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The AWS account ID of the subscription's owner.

  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

Returns:

  • (Hash<String,String>)


79
80
81
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 79

def attributes
  data[:attributes]
end

#clientClient

Returns:



86
87
88
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 86

def client
  @client
end

#dataTypes::GetSubscriptionAttributesResponse

Returns the data for this Aws::SNS::Subscription. Calls Client#get_subscription_attributes if #data_loaded? is false.



106
107
108
109
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 106

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



114
115
116
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 114

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


subscription.delete()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:

  • (EmptyStructure)


125
126
127
128
129
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 125

def delete(options = {})
  options = options.merge(subscription_arn: @arn)
  resp = @client.unsubscribe(options)
  resp.data
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::SNS::Subscription. Returns self making it possible to chain methods.

subscription.reload.data

Returns:

  • (self)


96
97
98
99
100
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 96

def load
  resp = @client.get_subscription_attributes(subscription_arn: @arn)
  @data = resp.data
  self
end

#set_attributes(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


subscription.set_attributes({
  attribute_name: "attributeName", # required
  attribute_value: "attributeValue",
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :attribute_name (required, String)

    A map of attributes with their corresponding values.

    The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

    • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

    • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

    • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

  • :attribute_value (String)

    The new value for the attribute in JSON format.

Returns:

  • (EmptyStructure)


165
166
167
168
169
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 165

def set_attributes(options = {})
  options = options.merge(subscription_arn: @arn)
  resp = @client.set_subscription_attributes(options)
  resp.data
end