You are viewing documentation for version 1 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: AWS::SNS::TopicCollection

Inherits:

Object

• Object
• AWS::SNS::TopicCollection

Includes:

Core::Collection::WithNextToken

Defined in:

lib/aws/sns/topic_collection.rb

Instance Method Summary

• #[](topic_arn) ⇒ Topic

  Returns a topic with the given Topic ARN.

• #create(name) ⇒ Topic

  Creates and returns a new SNS Topic.

Methods included from Core::Collection

#each, #each_batch, #enum, #first, #in_groups_of, #page

Instance Method Details

#[](topic_arn) ⇒ Topic

Returns a topic with the given Topic ARN.

Parameters:

• topic_arn (String) —

  An AWS SNS Topic ARN. It should be formatted something like:

  arn:aws:sns:us-west-2:123456789012:TopicName
  

Returns:

• (Topic) —

  Returns a topic with the given Topic ARN.

# File 'lib/aws/sns/topic_collection.rb', line 34

def [] topic_arn
  unless topic_arn =~ /^arn:aws/
    raise ArgumentError, "invalid topic arn `#{topic_arn}`"
  end
  Topic.new(topic_arn, :config => config)
end

#create(name) ⇒ Topic

Creates and returns a new SNS Topic.

Returns:

• (Topic) —

  Returns a new topic with the given name.

# File 'lib/aws/sns/topic_collection.rb', line 23

def create name
  response = client.create_topic(:name => name)
  Topic.new(response.topic_arn, :config => config)
end