Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-sns-topic.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::SNS::Topic. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sns

Properties

DisplayName string | Aws_CF_FunctionString

The display name to use for an Amazon SNS topic with SMS subscriptions.

KmsMasterKeyId string | Aws_CF_FunctionString

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.

This property applies only to server-side-encryption.

DataProtectionPolicy object

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 30720

Subscription Subscription[]

The SNS subscriptions (endpoints) for this topic.

FifoTopic boolean

Set to true to create a FIFO topic.

ContentBasedDeduplication boolean

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.

Tags Tag[]
TopicName string | Aws_CF_FunctionString

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

SignatureVersion string | Aws_CF_FunctionString

Version of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values.

TracingConfig string | Aws_CF_FunctionString

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.

Definitions

Tag object
Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString required

The value for the tag. You can specify a value that is 0 to 256 characters in length.

Subscription object
Endpoint string | Aws_CF_FunctionString required
Protocol string | Aws_CF_FunctionString required