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.94.0 (build b380f01)",
           date="2024-03-14T22:22:02.072Z")
@Stability(Stable)
public interface TopicProps
extends software.amazon.jsii.JsiiSerializable

Properties for a new SNS topic.

Example:

 Topic topic = Topic.Builder.create(this, "Topic")
         .contentBasedDeduplication(true)
         .displayName("Customer subscription topic")
         .fifo(true)
         .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 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	getTopicName()	A name for the 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.

Default: None

getEnforceSSL

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

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.

Default: false

getFifo

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

Set to true to create a FIFO topic.

Default: None

getLoggingConfigs

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

The list of delivery status logging configurations for the topic.

For more information, see https://docs.aws.amazon.com/sns/latest/dg/sns-topic-attributes.html.

Default: None

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

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

builder

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

Returns:

a TopicProps.Builder of TopicProps