Class: Aws::SNS::Subscription

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
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 '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

#arn ⇒ String

Returns:

  • (String) 


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

def arn
  @arn
end

#attributes ⇒ Hash<String,String>

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

  • ‘ConfirmationWasAuthenticated` – `true` 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*.

  • ‘FilterPolicyScope` – This attribute lets you choose the filtering scope by using one of the following string value types:

    • ‘MessageAttributes` (default) – The filter is applied on the message attributes.

    • ‘MessageBody` – The filter is applied on the message body.

  • ‘Owner` – The Amazon Web Services account ID of the subscription’s owner.

  • ‘PendingConfirmation` – `true` if the subscription hasn’t been confirmed. To confirm a pending subscription, call the ‘ConfirmSubscription` action with a confirmation token.

  • ‘RawMessageDelivery` – `true` 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.

The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:

  • ‘SubscriptionRoleArn` – The ARN of the IAM role that has the following:

    • Permission to write to the Firehose delivery stream

    • Amazon SNS listed as a trusted entity

    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see [Fanout to Firehose delivery streams] in the *Amazon SNS Developer Guide*.

[1]: docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html [2]: docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html

Returns:

  • (Hash<String,String>) 


101
102
103
 
# File 'lib/aws-sdk-sns/subscription.rb', line 101

def attributes
  data[:attributes]
end

#client ⇒ Client

Returns:



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

def client
  @client
end

#data ⇒ Types::GetSubscriptionAttributesResponse

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

Returns:



130
131
132
133
 
# File 'lib/aws-sdk-sns/subscription.rb', line 130

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.



138
139
140
 
# File 'lib/aws-sdk-sns/subscription.rb', line 138

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


subscription.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-sns/subscription.rb', line 149

def delete(options = {})
  options = options.merge(subscription_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.unsubscribe(options)
  end
  resp.data
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


225
226
227
 
# File 'lib/aws-sdk-sns/subscription.rb', line 225

def identifiers
  { arn: @arn }
end

#load ⇒ self 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) 


118
119
120
121
122
123
124
 
# File 'lib/aws-sdk-sns/subscription.rb', line 118

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.get_subscription_attributes(subscription_arn: @arn)
  end
  @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 this 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.

    • ‘FilterPolicyScope` – This attribute lets you choose the filtering scope by using one of the following string value types:

      • ‘MessageAttributes` (default) – The filter is applied on the message attributes.

      • ‘MessageBody` – The filter is applied on the message body.

    • ‘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.

    The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:

    • ‘SubscriptionRoleArn` – The ARN of the IAM role that has the following:

      • Permission to write to the Firehose delivery stream

      • Amazon SNS listed as a trusted entity

      Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see [Fanout to Firehose delivery streams] in the *Amazon SNS Developer Guide*.

    [1]: docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html

  • :attribute_value (String) —

    The new value for the attribute in JSON format.

Returns:

  • (EmptyStructure) 


215
216
217
218
219
220
221
 
# File 'lib/aws-sdk-sns/subscription.rb', line 215

def set_attributes(options = {})
  options = options.merge(subscription_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.set_subscription_attributes(options)
  end
  resp.data
end