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).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

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" : {
      "ArchivePolicy" : Json,
      "ContentBasedDeduplication" : Boolean,
      "DataProtectionPolicy" : Json,
      "DeliveryStatusLogging" : [ LoggingConfig, ... ],
      "DisplayName" : String,
      "FifoThroughputScope" : String,
      "FifoTopic" : Boolean,
      "KmsMasterKeyId" : String,
      "SignatureVersion" : String,
      "Subscription" : [ Subscription, ... ],
      "Tags" : [ Tag, ... ],
      "TopicName" : String,
      "TracingConfig" : String
    }
}

Properties

ArchivePolicy

The ArchivePolicy determines the number of days Amazon SNS retains messages in FIFO topics. You can set a retention period ranging from 1 to 365 days. This property is only applicable to FIFO topics; attempting to use it with standard topics will result in a creation failure.

Required: No

Type: Json

Update requires: No interruption

ContentBasedDeduplication

ContentBasedDeduplication enables deduplication of messages based on their content for FIFO topics. By default, this property is set to false. If you create a FIFO topic with ContentBasedDeduplication set to false, you must provide a MessageDeduplicationId for each Publish action. When set to true, Amazon SNS automatically generates a MessageDeduplicationId using a SHA-256 hash of the message body (excluding message attributes). You can optionally override this generated value by specifying a MessageDeduplicationId in the Publish action. Note that this property only applies to FIFO topics; using it with standard topics will cause the creation to fail.

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

DeliveryStatusLogging

The DeliveryStatusLogging configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols:

  • HTTP

  • Amazon Kinesis Data Firehose

  • Amazon Lambda

  • Platform application endpoint

  • Amazon Simple Queue Service

Once configured, log entries are sent to Amazon CloudWatch Logs.

Required: No

Type: Array of LoggingConfig

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

FifoThroughputScope

Specifies the throughput quota and deduplication behavior to apply for the FIFO topic. Valid values are Topic or MessageGroup.

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: Array 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: Array 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 Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.

Required: No

Type: String

Update requires: No interruption

Return values

Ref

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

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic 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::GetAtt intrinsic 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",
      "ArchivePolicy": {
      "MessageRetentionPeriod": "7"
      }
    }
  },
  "Outputs": {
    "TopicArn": {
      "Description": "The ARN of the created SNS topic",
      "Value": {
        "Ref": "MySNSTopic"
      }
    },
    "TopicName": {
      "Description": "The name of the created SNS topic",
      "Value": "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"
    ArchivePolicy:
      MessageRetentionPeriod: "7"

Outputs:
  TopicArn:
    Description: The ARN of the created SNS topic
    Value: !Ref MySNSTopic
  TopicName:
    Description: The name of the created SNS topic
    Value: "SampleTopic"

See also