Class: Aws::SNS::Types::CreateTopicInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb

Overview

Note:

When making an API call, you may pass CreateTopicInput data as a hash:

{
  name: "topicName", # required
  attributes: {
    "attributeName" => "attributeValue",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Input for CreateTopic action.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributesHash<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.

^

Returns:

  • (Hash<String,String>)


368
369
370
371
372
373
374
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 368

class CreateTopicInput < Struct.new(
  :name,
  :attributes,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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.

Returns:

  • (String)


368
369
370
371
372
373
374
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 368

class CreateTopicInput < Struct.new(
  :name,
  :attributes,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<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.

Returns:



368
369
370
371
372
373
374
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 368

class CreateTopicInput < Struct.new(
  :name,
  :attributes,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end