Class: Aws::SNS::Resource

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

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Resource

Returns a new instance of Resource.

Parameters:

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

Options Hash (options):



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

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

Instance Method Details

#client ⇒ Client

Returns:



32
33
34
 
# File '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]

    [1]: docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html

Returns:



63
64
65
66
67
68
69
 
# File 'lib/aws-sdk-sns/resource.rb', line 63

def create_platform_application(options = {})
  resp = @client.create_platform_application(options)
  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
    },
  ],
})

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.

  • :attributes (Hash<String,String>) —

    A map of attributes with their corresponding values.

    The following lists the 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.

    The following attribute applies only to [server-side-encryption]:

    • ‘KmsMasterKeyId` - The ID of an AWS-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 *AWS Key Management Service API Reference*.

    ^

    [1]: docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html [2]: docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms [3]: docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters

  • :tags (Array<Types::Tag>) —

    The list of tags to add to a new topic.

    <note markdown=“1”> To be able to tag a topic on creation, you must have the ‘sns:CreateTopic` and `sns:TagResource` permissions.

    </note>

Returns:



129
130
131
132
133
134
135
 
# File 'lib/aws-sdk-sns/resource.rb', line 129

def create_topic(options = {})
  resp = @client.create_topic(options)
  Topic.new(
    arn: resp.data.topic_arn,
    client: @client
  )
end

#platform_application(arn) ⇒ PlatformApplication

Parameters:

  • arn (String)

Returns:



141
142
143
144
145
146
 
# File 'lib/aws-sdk-sns/resource.rb', line 141

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:



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/aws-sdk-sns/resource.rb', line 153

def platform_applications(options = {})
  batches = Enumerator.new do |y|
    resp = @client.list_platform_applications(options)
    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:



172
173
174
175
176
177
 
# File 'lib/aws-sdk-sns/resource.rb', line 172

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

#subscription(arn) ⇒ Subscription

Parameters:

  • arn (String)

Returns:



181
182
183
184
185
186
 
# File 'lib/aws-sdk-sns/resource.rb', line 181

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:



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/aws-sdk-sns/resource.rb', line 193

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



212
213
214
215
216
217
 
# File 'lib/aws-sdk-sns/resource.rb', line 212

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:



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/aws-sdk-sns/resource.rb', line 224

def topics(options = {})
  batches = Enumerator.new do |y|
    resp = @client.list_topics(options)
    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