Data Source schema for AWS::SNS::Topic
id
(String) Uniquely identifies the resource.archive_policy
(String) The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.content_based_deduplication
(Boolean) Enables content-based deduplication for FIFO topics.
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. ContentBasedDeduplication
to true
, 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 the MessageDeduplicationId
parameter for the Publish
action.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.delivery_status_logging
(Attributes Set) (see below for nested schema)display_name
(String) The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.fifo_topic
(Boolean) Set to true to create a FIFO topic.kms_master_key_id
(String) The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see Key terms. For more examples, see KeyId
in the API Reference.
This property applies only to server-side-encryption.signature_version
(String) 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 to 1
.subscription
(Attributes List) The SNS subscriptions (endpoints) for this topic.
If you specify the Subscription
property in the AWS::SNS::Topic
resource and it creates an associated subscription resource, the associated subscription is not deleted when the AWS::SNS::Topic
resource is deleted. (see below for nested schema)tags
(Attributes List) 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. (see below for nested schema)topic_arn
(String)topic_name
(String) The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo
.
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see Name type.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.tracing_config
(String) Tracing mode of an SNS topic. By default TracingConfig
is set to PassThrough
, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active
, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.delivery_status_logging
Read-Only:
failure_feedback_role_arn
(String)protocol
(String)success_feedback_role_arn
(String)success_feedback_sample_rate
(String)subscription
Read-Only:
endpoint
(String) The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the Endpoint
parameter of the Subscribe
action in the API Reference.protocol
(String) The subscription's protocol. For more information, see the Protocol
parameter of the Subscribe
action in the API Reference.tags
Read-Only:
key
(String) The required key portion of the tag.value
(String) The optional value portion of the tag.