Class: Aws::SNS::Types::CreateTopicInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SNS::Types::CreateTopicInput
- Defined in:
- gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb
Overview
Input for CreateTopic action.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#attributes ⇒ Hash<String,String>
A map of attributes with their corresponding values.
-
#data_protection_policy ⇒ String
The body of the policy document you want to use for this topic.
-
#name ⇒ String
The name of the topic you want to create.
-
#tags ⇒ Array<Types::Tag>
The list of tags to add to a new topic.
Instance Attribute Details
#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.FifoTopic
– Set to true to create a FIFO topic.Policy
– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.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 to1
.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:
ArchivePolicy
– Adds or updates an inline policy document to archive messages stored in the specified Amazon SNS topic.BeginningArchiveTime
– The earliest starting point at which a message in the topic’s archive can be replayed from. This point in time is based on the configured message retention period set by the topic’s message archiving policy.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.
443 444 445 446 447 448 449 450 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 443 class CreateTopicInput < Struct.new( :name, :attributes, :tags, :data_protection_policy) SENSITIVE = [] include Aws::Structure end |
#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.
443 444 445 446 447 448 449 450 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 443 class CreateTopicInput < Struct.new( :name, :attributes, :tags, :data_protection_policy) SENSITIVE = [] include Aws::Structure end |
#name ⇒ 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.
443 444 445 446 447 448 449 450 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 443 class CreateTopicInput < Struct.new( :name, :attributes, :tags, :data_protection_policy) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
The list of tags to add to a new topic.
sns:CreateTopic
and sns:TagResource
permissions.
443 444 445 446 447 448 449 450 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/types.rb', line 443 class CreateTopicInput < Struct.new( :name, :attributes, :tags, :data_protection_policy) SENSITIVE = [] include Aws::Structure end |