Class TopicProps
Properties for a new SNS topic.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.SNS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class TopicProps : Object, ITopicProps
Syntax (vb)
Public Class TopicProps
Inherits Object
Implements ITopicProps
Remarks
ExampleMetadata: infused
Examples
var topic = new Topic(this, "MyTopic", new TopicProps {
TracingConfig = TracingConfig.ACTIVE
});
Synopsis
Constructors
TopicProps() |
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. |
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. |
Constructors
TopicProps()
public TopicProps()
Properties
ContentBasedDeduplication
Enables content-based deduplication for FIFO topics.
public Nullable<bool> ContentBasedDeduplication { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: None
DisplayName
A developer-defined string that can be used to identify this SNS topic.
public string DisplayName { get; set; }
Property Value
System.String
Remarks
Default: None
EnforceSSL
Adds a statement to enforce encryption of data in transit when publishing to the topic.
public Nullable<bool> EnforceSSL { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Fifo
Set to true to create a FIFO topic.
public Nullable<bool> Fifo { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: None
LoggingConfigs
The list of delivery status logging configurations for the topic.
public ILoggingConfig[] LoggingConfigs { get; set; }
Property Value
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.
public IKey MasterKey { get; set; }
Property Value
Remarks
Default: None
MessageRetentionPeriodInDays
The number of days Amazon SNS retains messages.
public Nullable<double> MessageRetentionPeriodInDays { get; set; }
Property Value
System.Nullable<System.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.
public string SignatureVersion { get; set; }
Property Value
System.String
Remarks
TopicName
A name for the topic.
public string TopicName { get; set; }
Property Value
System.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.
public Nullable<TracingConfig> TracingConfig { get; set; }
Property Value
System.Nullable<TracingConfig>
Remarks
Default: TracingConfig.PASS_THROUGH
See: https://docs.aws.amazon.com/sns/latest/dg/sns-active-tracing.html