AWS::SNS::Topic - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::SNS::Topic

The AWS::SNS::Topic resource creates a topic to which notifications can be published.

Note

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see Amazon SNS endpoints and quotas in the Amazon General Reference.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SNS::Topic",
  "Properties" : {
      "ContentBasedDeduplication" : Boolean,
      "DataProtectionPolicy" : Json,
      "DisplayName" : String,
      "FifoTopic" : Boolean,
      "KmsMasterKeyId" : String,
      "SignatureVersion" : String,
      "Subscription" : [ Subscription, ... ],
      "Tags" : [ Tag, ... ],
      "TopicName" : String,
      "TracingConfig" : String
    }
}

YAML

Type: AWS::SNS::Topic
Properties: 
  ContentBasedDeduplication: Boolean
  DataProtectionPolicy: Json
  DisplayName: String
  FifoTopic: Boolean
  KmsMasterKeyId: String
  SignatureVersion: String
  Subscription: 
    - Subscription
  Tags: 
    - Tag
  TopicName: String
  TracingConfig: String

Properties

ContentBasedDeduplication

Enables content-based deduplication for FIFO topics.

  • By default, 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.

  • When you set ContentBasedDeduplication to true, Amazon 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.

Required: No

Type: Boolean

Update requires: No interruption

DataProtectionPolicy

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.

Required: No

Type: Json

Update requires: No interruption

DisplayName

The display name to use for an Amazon SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.

Required: No

Type: String

Update requires: No interruption

FifoTopic

Set to true to create a FIFO topic.

Required: No

Type: Boolean

Update requires: Replacement

KmsMasterKeyId

The ID of an Amazon 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 Amazon Key Management Service API Reference.

This property applies only to server-side-encryption.

Required: No

Type: String

Update requires: No interruption

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 to 1.

Required: No

Type: String

Update requires: No interruption

Subscription

The Amazon SNS subscriptions (endpoints) for this topic.

Important

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.

Required: No

Type: List of Subscription

Update requires: No interruption

Tags

The list of tags to add to a new topic.

Note

To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.

Required: No

Type: List of Tag

Update requires: No interruption

TopicName

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, Amazon CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name type.

Important

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.

Required: No

Type: String

Update requires: Replacement

TracingConfig

Tracing mode of an Amazon 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. Only supported on standard topics.

Required: No

Type: String

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the topic ARN, for example: arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE.

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAttintrinsic function, see Fn::GetAtt.

TopicArn

Returns the ARN of an Amazon SNS topic.

TopicName

Returns the name of an Amazon SNS topic.

Examples

An Amazon SNS topic with two Amazon SQS queue subscriptions

JSON

"MySNSTopic" : {
  "Type" : "AWS::SNS::Topic",
  "Properties" : {
    "Subscription" : [{
      "Endpoint" : { "Fn::GetAtt" : [ "MyQueue1", "Arn" ] },
      "Protocol" : "sqs"
    }, {
      "Endpoint" : { "Fn::GetAtt" : [ "MyQueue2", "Arn" ] },
      "Protocol" : "sqs"
    }],
    "TopicName" : "SampleTopic"
  }
}

YAML

MySNSTopic:
  Type: AWS::SNS::Topic
  Properties:
    Subscription:
      - Endpoint:
          Fn::GetAtt:
            - "MyQueue1"
            - "Arn"
        Protocol: "sqs"
      - Endpoint:
          Fn::GetAtt:
            - "MyQueue2"
            - "Arn"
        Protocol: "sqs"
    TopicName: "SampleTopic"

See also