Class: Aws::SNS::Subscription
- Inherits:
-
Object
- Object
- Aws::SNS::Subscription
- Extended by:
- Deprecations
- Defined in:
- 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
- #delete(options = {}) ⇒ EmptyStructure
- #identifiers ⇒ Object deprecated private Deprecated.
- #set_attributes(options = {}) ⇒ EmptyStructure
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.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-sns/subscription.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @arn = extract_arn(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#arn ⇒ String
29 30 31 |
# File 'lib/aws-sdk-sns/subscription.rb', line 29 def arn @arn end |
#attributes ⇒ Hash<String,String>
A map of the subscription’s attributes. Attributes in this map include the following:
-
‘SubscriptionArn` – the subscription’s ARN
-
‘TopicArn` – the topic ARN that the subscription is associated with
-
‘Owner` – the AWS account ID of the subscription’s owner
-
‘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
52 53 54 |
# File 'lib/aws-sdk-sns/subscription.rb', line 52 def attributes data.attributes end |
#data ⇒ Types::GetSubscriptionAttributesResponse
Returns the data for this Aws::SNS::Subscription. Calls Client#get_subscription_attributes if #data_loaded? is ‘false`.
79 80 81 82 |
# File 'lib/aws-sdk-sns/subscription.rb', line 79 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
87 88 89 |
# File 'lib/aws-sdk-sns/subscription.rb', line 87 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
98 99 100 101 102 |
# File 'lib/aws-sdk-sns/subscription.rb', line 98 def delete( = {}) = .merge(subscription_arn: @arn) resp = @client.unsubscribe() 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.
127 128 129 |
# File 'lib/aws-sdk-sns/subscription.rb', line 127 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
69 70 71 72 73 |
# File 'lib/aws-sdk-sns/subscription.rb', line 69 def load resp = @client.get_subscription_attributes(subscription_arn: @arn) @data = resp.data self end |
#set_attributes(options = {}) ⇒ EmptyStructure
119 120 121 122 123 |
# File 'lib/aws-sdk-sns/subscription.rb', line 119 def set_attributes( = {}) = .merge(subscription_arn: @arn) resp = @client.set_subscription_attributes() resp.data end |