aws-cdk-lib.aws_sns.CfnTopicProps

CfnTopicProps Struct

Properties for defining a CfnTopic.

Source

Generated code

Type last changed

v2.272.0 · 30 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sns as sns } from 'aws-cdk-lib';

declare const archivePolicy: any;
declare const dataProtectionPolicy: any;
const cfnTopicProps: sns.CfnTopicProps = {
  archivePolicy: archivePolicy,
  contentBasedDeduplication: false,
  dataProtectionPolicy: dataProtectionPolicy,
  deliveryStatusLogging: [{
    protocol: 'protocol',

    // the properties below are optional
    failureFeedbackRoleArn: 'failureFeedbackRoleArn',
    successFeedbackRoleArn: 'successFeedbackRoleArn',
    successFeedbackSampleRate: 'successFeedbackSampleRate',
  }],
  displayName: 'displayName',
  fifoThroughputScope: 'fifoThroughputScope',
  fifoTopic: false,
  kmsMasterKeyId: 'kmsMasterKeyId',
  maximumMessageSize: 123,
  signatureVersion: 'signatureVersion',
  subscription: [{
    endpoint: 'endpoint',
    protocol: 'protocol',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  topicName: 'topicName',
  tracingConfig: 'tracingConfig',
};

Properties

archivePolicyanyarchive_policyAnyarchivePolicyObjectArchivePolicyobjectArchivePolicyinterface{}#

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.

contentBasedDeduplicationboolean | IResolvablecontent_based_deduplicationtyping.Union[bool, IResolvable]contentBasedDeduplicationBooleanContentBasedDeduplicationboolContentBasedDeduplicationinterface{}#

`ContentBasedDeduplication` enables deduplication of messages based on their content for FIFO topics.

notes

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.

dataProtectionPolicyanydata_protection_policyAnydataProtectionPolicyObjectDataProtectionPolicyobjectDataProtectionPolicyinterface{}#

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.

deliveryStatusLoggingIResolvable | IResolvable | CfnTopic.LoggingConfigProperty[]delivery_status_loggingtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LoggingConfigProperty]]]deliveryStatusLoggingIResolvableDeliveryStatusLoggingIResolvableDeliveryStatusLogginginterface{}#

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.

displayNamestringdisplay_namestrdisplayNameStringDisplayNamestringDisplayName*string#

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.

fifoThroughputScopestringfifo_throughput_scopestrfifoThroughputScopeStringFifoThroughputScopestringFifoThroughputScope*string#

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

Valid values are Topic or MessageGroup .

fifoTopicboolean | IResolvablefifo_topictyping.Union[bool, IResolvable]fifoTopicBooleanFifoTopicboolFifoTopicinterface{}#

Set to true to create a FIFO topic.

kmsMasterKeyIdstring | IAliasRef | IKeyRefkms_master_key_idtyping.Union[str, IAliasRef, IKeyRef]kmsMasterKeyIdStringKmsMasterKeyIdstringKmsMasterKeyIdinterface{}#

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

notes

For more information, see 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 .

maximumMessageSizenumbermaximum_message_sizeint | floatmaximumMessageSizeNumberMaximumMessageSizedoubleMaximumMessageSize*float64#

signatureVersionstringsignature_versionstrsignatureVersionStringSignatureVersionstringSignatureVersion*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 .

subscriptionIResolvable | IResolvable | CfnTopic.SubscriptionProperty[]subscriptiontyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SubscriptionProperty]]]subscriptionIResolvableSubscriptionIResolvableSubscriptioninterface{}#

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.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

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.

topicNamestringtopic_namestrtopicNameStringTopicNamestringTopicName*string#

The name of the topic you want to create.

notes

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, CloudFormation 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.

tracingConfigstringtracing_configstrtracingConfigStringTracingConfigstringTracingConfig*string#

Tracing mode of an Amazon topic.

notes

By default TracingConfig is set to PassThrough , and the topic passes through the tracing header it receives from an Amazon publisher to its subscriptions. If set to Active , Amazon will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.

Used as props by

• CfnTopic