A new subscription.

Prefer to use the `ITopic.addSubscription()` methods to create instances of
this class.

Subscription

topic

The subscription endpoint.

The meaning of this value depends on the value for 'protocol'.

endpoint

protocol

Queue to be used as dead letter queue.

If not passed no dead letter queue is enabled.

deadLetterQueue

deliveryPolicy

filterPolicy

The filter policy that is applied on the message body.

To apply a filter policy to the message attributes, use `filterPolicy`. A maximum of one of `filterPolicyWithMessageBody` and `filterPolicy` may be used.

filterPolicyWithMessageBody

true if raw message delivery is enabled for the subscription.

Raw messages are free of JSON formatting and can be
sent to HTTP/S and Amazon SQS endpoints. For more information, see GetSubscriptionAttributes in the Amazon Simple
Notification Service API Reference.

rawMessageDelivery

The region where the topic resides, in the case of cross-region subscriptions.

region

Arn of role allowing access to firehose delivery stream.

Required for a firehose subscription protocol.

subscriptionRoleArn

Adds a delivery status logging configuration to the topic.

addLoggingConfig

Topic

Enables content-based deduplication for FIFO topics.

contentBasedDeduplication

A developer-defined string that can be used to identify this SNS topic.

The display name must be maximum 100 characters long, including hyphens (-),
underscores (_), spaces, and tabs.

displayName

Adds a statement to enforce encryption of data in transit when publishing to the topic.

enforceSSL

fifo

Specifies the throughput quota and deduplication behavior to apply for the FIFO topic.

You can only set this property when `fifo` is `true`.

fifoThroughputScope

The list of delivery status logging configurations for the topic.

loggingConfigs

A KMS Key, either managed by this CDK app, or imported.

masterKey

The number of days Amazon SNS retains messages.

It can only be set for FIFO topics.

messageRetentionPeriodInDays

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.

signatureVersion

A name for the topic.

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.

topicName

tracingConfig

The policy for an SNS Topic.

Policies define the operations that are allowed on this resource.

You almost never need to define this construct directly.

All AWS resources that support resource policies have a method called
`addToResourcePolicy()`, which will automatically create a new resource
policy if one doesn't exist yet, otherwise it will add to the existing
policy.

Prefer to use `addToResourcePolicy()` instead.

TopicPolicy

The set of topics this policy applies to.

topics

Adds a statement to enforce encryption of data in transit when publishing to the topic.

For more information, see https://docs.aws.amazon.com/sns/latest/dg/sns-security-best-practices.html#enforce-encryption-data-in-transit.

IAM policy document to apply to topic(s).

policyDocument

The `AWS::SNS::Subscription` resource subscribes an endpoint to an Amazon  topic.

For a subscription to be created, the owner of the endpoint must` confirm the subscription.

CfnSubscription

The subscription's protocol.

For more information, see the `Protocol` parameter of the `[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)` action in the *Amazon  API Reference* .

topicArn

The delivery policy JSON assigned to the subscription.

Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon  API Reference* and [Message delivery retries](https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html) in the *Amazon  Developer Guide* .

The subscription's endpoint.

The endpoint value depends on the protocol that you specify. For more information, see the `Endpoint` parameter of the `[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)` action in the *Amazon  API Reference* .

The filter policy JSON assigned to the subscription.

Enables the subscriber to filter out unwanted messages. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon  API Reference* and [Message filtering](https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) in the *Amazon  Developer Guide* .

This attribute lets you choose the filtering scope by using one of the following string value types:.

- `MessageAttributes` (default) - The filter is applied on the message attributes.
- `MessageBody` - The filter is applied on the message body.

> `Null` is not a valid value for `FilterPolicyScope` . To delete a filter policy, delete the `FilterPolicy` property but keep `FilterPolicyScope` property as is.

filterPolicyScope

When set to `true` , enables raw message delivery.

Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon  API Reference* .

When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.

Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

For more information about the redrive policy and dead-letter queues, see [Amazon SQS dead-letter queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) in the *Amazon SQS Developer Guide* .

redrivePolicy

For cross-region subscriptions, the region in which the topic resides.

If no region is specified, CloudFormation uses the region of the caller as the default.

If you perform an update operation that only updates the `Region` property of a `AWS::SNS::Subscription` resource, that operation will fail unless you are either:

- Updating the `Region` from `NULL` to the caller region.
- Updating the `Region` from the caller region to `NULL` .

Specifies whether Amazon  resends the notification to the subscription when a message's attribute changes.

replayPolicy

This property applies only to Amazon Data Firehose delivery stream subscriptions.

Specify the ARN of the IAM role that has the following:

- Permission to write to the Amazon Data Firehose delivery stream
- Amazon  listed as a trusted entity

Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see [Fanout to Amazon Data Firehose delivery streams](https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in the *Amazon  Developer Guide.*

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

> One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [Amazon  endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *AWS General Reference* .

CfnTopic

The `ArchivePolicy` determines the number of days Amazon  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.

archivePolicy

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

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.

dataProtectionPolicy

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
- AWS Lambda
- Platform application endpoint
- Amazon Simple Queue Service

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

deliveryStatusLogging

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

The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.

Specifies the throughput quota and deduplication behavior to apply for the FIFO topic.

Valid values are `Topic` or `MessageGroup` .

fifoTopic

The ID of an AWS managed customer master key (CMK) for Amazon  or a custom CMK.

For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms) . For more examples, see `[KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)` in the *AWS Key Management Service API Reference* .

This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html) .

kmsMasterKeyId

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

The Amazon  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.

subscription

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.

CfnTopicInlinePolicy

A policy document that contains permissions to add to the specified Amazon  topic.

The Amazon Resource Name (ARN) of the topic to which you want to add the policy.

The `AWS::SNS::TopicPolicy` resource associates Amazon  topics with a policy.

For an example snippet, see [Declaring an Amazon  policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sns-policy) in the *CloudFormation User Guide* .

CfnTopicPolicy

A policy document that contains permissions to add to the specified SNS topics.

The Amazon Resource Names (ARN) of the topics to which you want to add the policy.

You can use the `[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an `[AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html)` resource.

Amazon SNS

L2 Constructs3

Subscription

Topic

TopicPolicy

L1 Constructs4

CfnSubscription

CfnTopic

CfnTopicInlinePolicy

CfnTopicPolicy

Get the Amazon SNS Cheat Sheet

Quick Facts

Related Links

More Amazon SNS deep dives