Class: Aws::SNS::Resource

Inherits:

Object

Object
Aws::SNS::Resource

show all

Defined in:: gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb

Overview

This class provides a resource oriented interface for SNS. To create a resource object:

resource = Aws::SNS::Resource.new(region: 'us-west-2')

You can supply a client object with custom configuration that will be used for all resource operations. If you do not pass :client, a default client will be constructed.

client = Aws::SNS::Client.new(region: 'us-west-2')
resource = Aws::SNS::Resource.new(client: client)

Actions collapse

#create_platform_application(options = {}) ⇒ PlatformApplication
#create_topic(options = {}) ⇒ Topic

Associations collapse

#platform_application(arn) ⇒ PlatformApplication
#platform_applications(options = {}) ⇒ PlatformApplication::Collection
#platform_endpoint(arn) ⇒ PlatformEndpoint
#subscription(arn) ⇒ Subscription
#subscriptions(options = {}) ⇒ Subscription::Collection
#topic(arn) ⇒ Topic
#topics(options = {}) ⇒ Topic::Collection

Instance Method Summary collapse

#client ⇒ Client
#initialize(options = {}) ⇒ Resource constructor
A new instance of Resource.

Constructor Details

#initialize(options = {}) ⇒ `Resource`

Returns a new instance of Resource.

Parameters:

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

Options Hash (options):

:client (Client)



27
28
29

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 27

def initialize(options = {})
  @client = options[:client] || Client.new(options)
end

Instance Method Details

#client ⇒ `Client`

Returns:

(Client)



32
33
34

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 32

def client
  @client
end

#create_platform_application(options = {}) ⇒ `PlatformApplication`

Examples:

Request syntax with placeholder values


platformapplication = sns.create_platform_application({
  name: "String", # required
  platform: "String", # required
  attributes: { # required
    "String" => "String",
  },
})

Parameters:

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

Options Hash (options):

:name (required, String) —
Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
:platform (required, String) —
The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).
:attributes (required, Hash<String,String>) —
For a list of attributes, see SetPlatformApplicationAttributes .

Returns:

(PlatformApplication)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 64

def create_platform_application(options = {})
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.create_platform_application(options)
  end
  PlatformApplication.new(
    arn: resp.data.platform_application_arn,
    client: @client
  )
end

#create_topic(options = {}) ⇒ `Topic`

Examples:

Request syntax with placeholder values


topic = sns.create_topic({
  name: "topicName", # required
  attributes: {
    "attributeName" => "attributeValue",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  data_protection_policy: "attributeValue",
})

Parameters:

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

Options Hash (options):

:name (required, String) —
The name of the topic you want to create.

Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.
:attributes (Hash<String,String>) —
A map of attributes with their corresponding values.

The following lists names, descriptions, and values of the special request parameters that the CreateTopic action uses:
- DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
- DisplayName – The display name to use for a topic with SMS subscriptions.
- Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
- TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, 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.
- HTTP
  - HTTPSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
  - HTTPSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.
  - HTTPFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
- Amazon Data Firehose
  - FirehoseSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint.
  - FirehoseSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint.
  - FirehoseFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint.
- Lambda
  - LambdaSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
  - LambdaSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.
  - LambdaFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
- Platform application endpoint
  - ApplicationSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.
  - ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an platform application endpoint.
  - ApplicationFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an platform application endpoint. In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.
  For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
- Amazon SQS
  - SQSSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
  - SQSSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
  - SQSFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs.

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:
- ArchivePolicy – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic.
- ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
  - By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
  - When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId 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 the Publish action. ^
- FifoThroughputScope – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:
  - Topic – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.
  - MessageGroup – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.
:tags (Array<Types::Tag>) —
The list of tags to add to a new topic.

To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.
:data_protection_policy (String) —
The body of the policy document you want to use for this topic.

You can only add one policy per topic.

The policy must be in JSON string format.

Length Constraints: Maximum length of 30,720.

Returns:

(Topic)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 280

def create_topic(options = {})
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.create_topic(options)
  end
  Topic.new(
    arn: resp.data.topic_arn,
    client: @client
  )
end

#platform_application(arn) ⇒ `PlatformApplication`

Parameters:

arn (String)

Returns:

(PlatformApplication)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 294

def platform_application(arn)
  PlatformApplication.new(
    arn: arn,
    client: @client
  )
end

#platform_applications(options = {}) ⇒ `PlatformApplication::Collection`

Examples:

Request syntax with placeholder values


sns.platform_applications()

Parameters:

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

Returns:

(PlatformApplication::Collection)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 306

def platform_applications(options = {})
  batches = Enumerator.new do |y|
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.list_platform_applications(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.platform_applications.each do |p|
        batch << PlatformApplication.new(
          arn: p.platform_application_arn,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  PlatformApplication::Collection.new(batches)
end

#platform_endpoint(arn) ⇒ `PlatformEndpoint`

Parameters:

arn (String)

Returns:

(PlatformEndpoint)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 327

def platform_endpoint(arn)
  PlatformEndpoint.new(
    arn: arn,
    client: @client
  )
end

#subscription(arn) ⇒ `Subscription`

Parameters:

arn (String)

Returns:

(Subscription)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 336

def subscription(arn)
  Subscription.new(
    arn: arn,
    client: @client
  )
end

#subscriptions(options = {}) ⇒ `Subscription::Collection`

Examples:

Request syntax with placeholder values


sns.subscriptions()

Parameters:

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

Returns:

(Subscription::Collection)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 348

def subscriptions(options = {})
  batches = Enumerator.new do |y|
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.list_subscriptions(options)
    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

#topic(arn) ⇒ `Topic`

Parameters:

arn (String)

Returns:

(Topic)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 369

def topic(arn)
  Topic.new(
    arn: arn,
    client: @client
  )
end

#topics(options = {}) ⇒ `Topic::Collection`

Examples:

Request syntax with placeholder values


sns.topics()

Parameters:

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

Returns:

(Topic::Collection)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/resource.rb', line 381

def topics(options = {})
  batches = Enumerator.new do |y|
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.list_topics(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.topics.each do |t|
        batch << Topic.new(
          arn: t.topic_arn,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Topic::Collection.new(batches)
end

Class: Aws::SNS::Resource

Overview

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Resource

Instance Method Details

#client ⇒ Client

#create_platform_application(options = {}) ⇒ PlatformApplication

Examples:

Request syntax with placeholder values

#create_topic(options = {}) ⇒ Topic

Examples:

Request syntax with placeholder values

#platform_application(arn) ⇒ PlatformApplication

#platform_applications(options = {}) ⇒ PlatformApplication::Collection

Examples:

Request syntax with placeholder values

#platform_endpoint(arn) ⇒ PlatformEndpoint

#subscription(arn) ⇒ Subscription

#subscriptions(options = {}) ⇒ Subscription::Collection

Examples:

Request syntax with placeholder values

#topic(arn) ⇒ Topic

#topics(options = {}) ⇒ Topic::Collection

Examples:

Request syntax with placeholder values

#initialize(options = {}) ⇒ `Resource`

#client ⇒ `Client`

#create_platform_application(options = {}) ⇒ `PlatformApplication`

#create_topic(options = {}) ⇒ `Topic`

#platform_application(arn) ⇒ `PlatformApplication`

#platform_applications(options = {}) ⇒ `PlatformApplication::Collection`

#platform_endpoint(arn) ⇒ `PlatformEndpoint`

#subscription(arn) ⇒ `Subscription`

#subscriptions(options = {}) ⇒ `Subscription::Collection`

#topic(arn) ⇒ `Topic`

#topics(options = {}) ⇒ `Topic::Collection`