Class: Aws::SNS::Subscription
- Inherits:
-
Object
- Object
- Aws::SNS::Subscription
- Defined in:
- gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#arn ⇒ String
-
#attributes ⇒ Hash<String,String>
A map of the subscription's attributes.
Actions collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::GetSubscriptionAttributesResponse
Returns the data for this Subscription.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ Subscription
constructor
A new instance of Subscription.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current Subscription.
Constructor Details
#initialize(arn, options = {}) ⇒ Subscription #initialize(options = {}) ⇒ Subscription
Returns a new instance of Subscription.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @arn = extract_arn(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#arn ⇒ String
33 34 35 |
# File 'gems/aws-sdk-sns/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 theConfirmSubscription
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 Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
104 105 106 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 104 def attributes data[:attributes] end |
#client ⇒ Client
111 112 113 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 111 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
.
133 134 135 136 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 133 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
141 142 143 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 141 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
152 153 154 155 156 157 158 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 152 def delete( = {}) = .merge(subscription_arn: @arn) resp = Aws::Plugins::UserAgent.feature('resource') do @client.unsubscribe() end resp.data 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
121 122 123 124 125 126 127 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 121 def load resp = Aws::Plugins::UserAgent.feature('resource') do @client.get_subscription_attributes(subscription_arn: @arn) end @data = resp.data self end |
#set_attributes(options = {}) ⇒ EmptyStructure
221 222 223 224 225 226 227 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/subscription.rb', line 221 def set_attributes( = {}) = .merge(subscription_arn: @arn) resp = Aws::Plugins::UserAgent.feature('resource') do @client.set_subscription_attributes() end resp.data end |