Package software.amazon.awscdk.services.sns

Interface TopicProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TopicProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:18.293Z")
@Stability(Stable)
public interface TopicProps
extends software.amazon.jsii.JsiiSerializable

Properties for a new SNS topic.

Example:

 Topic topic = Topic.Builder.create(this, "MyTopic")
         .fifo(true)
         .fifoThroughputScope(FifoThroughputScope.TOPIC)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	TopicProps.Builder	A builder for TopicProps
static final class	TopicProps.Jsii$Proxy	An implementation for TopicProps

Method Summary

Modifier and Type	Method	Description
static TopicProps.Builder	builder()
default Boolean	getContentBasedDeduplication()	Enables content-based deduplication for FIFO topics.
default String	getDisplayName()	A developer-defined string that can be used to identify this SNS topic.
default Boolean	getEnforceSSL()	Adds a statement to enforce encryption of data in transit when publishing to the topic.
default Boolean	getFifo()	Set to true to create a FIFO topic.
default FifoThroughputScope	getFifoThroughputScope()	Specifies the throughput quota and deduplication behavior to apply for the FIFO topic.
default List<LoggingConfig>	getLoggingConfigs()	The list of delivery status logging configurations for the topic.
default IKey	getMasterKey()	A KMS Key, either managed by this CDK app, or imported.
default Number	getMessageRetentionPeriodInDays()	The number of days Amazon SNS retains messages.
default String	getSignatureVersion()	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.
default String	getTopicName()	A name for the topic.
default TracingConfig	getTracingConfig()	Tracing mode of an Amazon SNS topic.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContentBasedDeduplication

@Stability(Stable)
@Nullable
default Boolean getContentBasedDeduplication()

Enables content-based deduplication for FIFO topics.

Default: None

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

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.

Default: None

getEnforceSSL

@Stability(Stable)
@Nullable
default Boolean getEnforceSSL()

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

Default: false

See Also:

• https://docs.aws.amazon.com/sns/latest/dg/sns-security-best-practices.html#enforce-encryption-data-in-transit.

getFifo

@Stability(Stable)
@Nullable
default Boolean getFifo()

Set to true to create a FIFO topic.

Default: None

getFifoThroughputScope

@Stability(Stable)
@Nullable
default FifoThroughputScope getFifoThroughputScope()

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

You can only set this property when fifo is true.

Default: undefined - SNS default setting is FifoThroughputScope.TOPIC

getLoggingConfigs

@Stability(Stable)
@Nullable
default List<LoggingConfig> getLoggingConfigs()

The list of delivery status logging configurations for the topic.

Default: None

See Also:

• https://docs.aws.amazon.com/sns/latest/dg/sns-topic-attributes.html.

getMasterKey

@Stability(Stable)
@Nullable
default IKey getMasterKey()

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

Default: None

getMessageRetentionPeriodInDays

@Stability(Stable)
@Nullable
default Number getMessageRetentionPeriodInDays()

The number of days Amazon SNS retains messages.

It can only be set for FIFO topics.

Default: - do not archive messages

See Also:

• https://docs.aws.amazon.com/sns/latest/dg/fifo-message-archiving-replay.html

getSignatureVersion

@Stability(Stable)
@Nullable
default String getSignatureVersion()

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.

Default: 1

See Also:

• https://docs.aws.amazon.com/sns/latest/dg/sns-verify-signature-of-message.html.

getTopicName

@Stability(Stable)
@Nullable
default String getTopicName()

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.

Default: Generated name

getTracingConfig

@Stability(Stable)
@Nullable
default TracingConfig getTracingConfig()

Tracing mode of an Amazon SNS topic.

Default: TracingConfig.PASS_THROUGH

See Also:

• https://docs.aws.amazon.com/sns/latest/dg/sns-active-tracing.html

builder

@Stability(Stable)
static TopicProps.Builder builder()

Returns:

a TopicProps.Builder of TopicProps