Interface ITopicProps

Properties for a new SNS topic.

Namespace: Amazon.CDK.AWS.SNS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ITopicProps

Syntax (vb)

Public Interface ITopicProps

Remarks

ExampleMetadata: infused

Examples

var topic = new Topic(this, "MyTopic", new TopicProps {
                Fifo = true,
                FifoThroughputScope = FifoThroughputScope.TOPIC
            });

Synopsis

Properties

ContentBasedDeduplication	Enables content-based deduplication for FIFO topics.
DisplayName	A developer-defined string that can be used to identify this SNS topic.
EnforceSSL	Adds a statement to enforce encryption of data in transit when publishing to the topic.
Fifo	Set to true to create a FIFO topic.
FifoThroughputScope	Specifies the throughput quota and deduplication behavior to apply for the FIFO topic.
LoggingConfigs	The list of delivery status logging configurations for the topic.
MasterKey	A KMS Key, either managed by this CDK app, or imported.
MessageRetentionPeriodInDays	The number of days Amazon SNS retains messages.
SignatureVersion	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.
TopicName	A name for the topic.
TracingConfig	Tracing mode of an Amazon SNS topic.

Properties

ContentBasedDeduplication

Enables content-based deduplication for FIFO topics.

bool? ContentBasedDeduplication { get; }

Property Value

bool?

Remarks

Default: None

DisplayName

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

string? DisplayName { get; }

Property Value

string

Remarks

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

Default: None

EnforceSSL

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

bool? EnforceSSL { get; }

Property Value

bool?

Remarks

Default: false

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

Fifo

Set to true to create a FIFO topic.

bool? Fifo { get; }

Property Value

bool?

Remarks

Default: None

FifoThroughputScope

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

FifoThroughputScope? FifoThroughputScope { get; }

Property Value

FifoThroughputScope?

Remarks

You can only set this property when fifo is true.

Default: undefined - SNS default setting is FifoThroughputScope.TOPIC

LoggingConfigs

The list of delivery status logging configurations for the topic.

ILoggingConfig[]? LoggingConfigs { get; }

Property Value

ILoggingConfig[]

Remarks

Default: None

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

MasterKey

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

IKey? MasterKey { get; }

Property Value

IKey

Remarks

Default: None

MessageRetentionPeriodInDays

The number of days Amazon SNS retains messages.

double? MessageRetentionPeriodInDays { get; }

Property Value

double?

Remarks

It can only be set for FIFO topics.

Default: - do not archive messages

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

SignatureVersion

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.

string? SignatureVersion { get; }

Property Value

string

Remarks

Default: 1

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

TopicName

A name for the topic.

string? TopicName { get; }

Property Value

string

Remarks

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

TracingConfig

Tracing mode of an Amazon SNS topic.

TracingConfig? TracingConfig { get; }

Property Value

TracingConfig?

Remarks

Default: TracingConfig.PASS_THROUGH

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