Class: Aws::SNS::Topic
- Inherits:
-
Object
- Object
- Aws::SNS::Topic
- Defined in:
- gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#arn ⇒ String
-
#attributes ⇒ Hash<String,String>
A map of the topic's attributes.
Actions collapse
-
#add_permission(options = {}) ⇒ EmptyStructure
-
#confirm_subscription(options = {}) ⇒ Subscription
-
#delete(options = {}) ⇒ EmptyStructure
-
#publish(options = {}) ⇒ Types::PublishResponse
-
#remove_permission(options = {}) ⇒ EmptyStructure
-
#set_attributes(options = {}) ⇒ EmptyStructure
-
#subscribe(options = {}) ⇒ Subscription
Associations collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::GetTopicAttributesResponse
Returns the data for this Topic.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ Topic
constructor
A new instance of Topic.
- #load ⇒ self (also: #reload)
Constructor Details
#initialize(arn, options = {}) ⇒ Topic #initialize(options = {}) ⇒ Topic
Returns a new instance of Topic.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.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
#add_permission(options = {}) ⇒ EmptyStructure
189 190 191 192 193 194 195 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 189 def ( = {}) = .merge(topic_arn: @arn) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.() end resp.data end |
#arn ⇒ String
33 34 35 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 33 def arn @arn end |
#attributes ⇒ Hash<String,String>
A map of the topic's attributes. Attributes in this map include the following:
DeliveryPolicy
– The JSON serialization of the topic's delivery policy.DisplayName
– The human-readable name used in theFrom
field for notifications toemail
andemail-json
endpoints.EffectiveDeliveryPolicy
– The JSON serialization of the effective delivery policy, taking system defaults into account.Owner
– The Amazon Web Services account ID of the topic's owner.Policy
– The JSON serialization of the topic's access control policy.SignatureVersion
– The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.By default,
SignatureVersion
is set to 1. The signature is a Base64-encoded SHA1withRSA signature.When you set
SignatureVersion
to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.If the API response does not include the SignatureVersion
attribute, it means that theSignatureVersion
for the topic has value 1.
SubscriptionsConfirmed
– The number of confirmed subscriptions for the topic.SubscriptionsDeleted
– The number of deleted subscriptions for the topic.SubscriptionsPending
– The number of subscriptions pending confirmation for the topic.TopicArn
– The topic's ARN.TracingConfig
– Tracing mode of an Amazon SNS topic. By defaultTracingConfig
is set toPassThrough
, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set toActive
, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId
- The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
^
The following attributes apply only to FIFO topics:
FifoTopic
– When this is set totrue
, a FIFO topic is created.ContentBasedDeduplication
– Enables content-based deduplication for FIFO topics.By default,
ContentBasedDeduplication
is set tofalse
. If you create a FIFO topic and this attribute isfalse
, you must specify a value for theMessageDeduplicationId
parameter for the Publish action.When you set
ContentBasedDeduplication
totrue
, Amazon SNS uses a SHA-256 hash to generate theMessageDeduplicationId
using the body of the message (but not the attributes of the message).(Optional) To override the generated value, you can specify a value for the
MessageDeduplicationId
parameter for thePublish
action.
126 127 128 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 126 def attributes data[:attributes] end |
#client ⇒ Client
133 134 135 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 133 def client @client end |
#confirm_subscription(options = {}) ⇒ Subscription
213 214 215 216 217 218 219 220 221 222 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 213 def confirm_subscription( = {}) = .merge(topic_arn: @arn) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.confirm_subscription() end Subscription.new( arn: resp.data.subscription_arn, client: @client ) end |
#data ⇒ Types::GetTopicAttributesResponse
Returns the data for this Aws::SNS::Topic. Calls
Client#get_topic_attributes if #data_loaded? is false
.
155 156 157 158 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 155 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
163 164 165 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 163 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
229 230 231 232 233 234 235 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 229 def delete( = {}) = .merge(topic_arn: @arn) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.delete_topic() end resp.data end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::SNS::Topic.
Returns self
making it possible to chain methods.
topic.reload.data
143 144 145 146 147 148 149 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 143 def load resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.get_topic_attributes(topic_arn: @arn) end @data = resp.data self end |
#publish(options = {}) ⇒ Types::PublishResponse
371 372 373 374 375 376 377 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 371 def publish( = {}) = .merge(topic_arn: @arn) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.publish() end resp.data end |
#remove_permission(options = {}) ⇒ EmptyStructure
388 389 390 391 392 393 394 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 388 def ( = {}) = .merge(topic_arn: @arn) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.() end resp.data end |
#set_attributes(options = {}) ⇒ EmptyStructure
563 564 565 566 567 568 569 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 563 def set_attributes( = {}) = .merge(topic_arn: @arn) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.set_topic_attributes() end resp.data end |
#subscribe(options = {}) ⇒ Subscription
719 720 721 722 723 724 725 726 727 728 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 719 def subscribe( = {}) = .merge(topic_arn: @arn) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.subscribe() end Subscription.new( arn: resp.data.subscription_arn, client: @client ) end |
#subscriptions(options = {}) ⇒ Subscription::Collection
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 737 def subscriptions( = {}) batches = Enumerator.new do |y| = .merge(topic_arn: @arn) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_subscriptions_by_topic() end resp.each_page do |page| batch = [] page.data.subscriptions.each do |s| batch << Subscription.new( arn: s.subscription_arn, client: @client ) end y.yield(batch) end end Subscription::Collection.new(batches) end |