Package software.amazon.awscdk.services.sns

Interface CfnTopicProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:24.013Z")
@Stability(Stable)
public interface CfnTopicProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTopic.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sns.*;
 Object archivePolicy;
 Object dataProtectionPolicy;
 CfnTopicProps cfnTopicProps = CfnTopicProps.builder()
         .archivePolicy(archivePolicy)
         .contentBasedDeduplication(false)
         .dataProtectionPolicy(dataProtectionPolicy)
         .deliveryStatusLogging(List.of(LoggingConfigProperty.builder()
                 .protocol("protocol")
                 // the properties below are optional
                 .failureFeedbackRoleArn("failureFeedbackRoleArn")
                 .successFeedbackRoleArn("successFeedbackRoleArn")
                 .successFeedbackSampleRate("successFeedbackSampleRate")
                 .build()))
         .displayName("displayName")
         .fifoTopic(false)
         .kmsMasterKeyId("kmsMasterKeyId")
         .signatureVersion("signatureVersion")
         .subscription(List.of(SubscriptionProperty.builder()
                 .endpoint("endpoint")
                 .protocol("protocol")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .topicName("topicName")
         .tracingConfig("tracingConfig")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicProps.Builder	builder()
default Object	getArchivePolicy()	The archive policy determines the number of days Amazon SNS retains messages.
default Object	getContentBasedDeduplication()	Enables content-based deduplication for FIFO topics.
default Object	getDataProtectionPolicy()	The body of the policy document you want to use for this topic.
default Object	getDeliveryStatusLogging()	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:.
default String	getDisplayName()	The display name to use for an Amazon SNS topic with SMS subscriptions.
default Object	getFifoTopic()	Set to true to create a FIFO topic.
default String	getKmsMasterKeyId()	The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK.
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 Object	getSubscription()	The Amazon SNS subscriptions (endpoints) for this topic.
default List<CfnTag>	getTags()	The list of tags to add to a new topic.
default String	getTopicName()	The name of the topic you want to create.
default String	getTracingConfig()	Tracing mode of an Amazon SNS topic.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getArchivePolicy

@Stability(Stable)
@Nullable
default Object getArchivePolicy()

The archive policy determines the number of days Amazon SNS retains messages.

You can set a retention period from 1 to 365 days.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-archivepolicy

getContentBasedDeduplication

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

Enables content-based deduplication for FIFO topics.

• By default, ContentBasedDeduplication is set to false . If you create a FIFO topic and this attribute is false , you must specify a value for the MessageDeduplicationId parameter for the Publish action.
• When you set ContentBasedDeduplication to true , Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-contentbaseddeduplication

getDataProtectionPolicy

@Stability(Stable)
@Nullable
default Object getDataProtectionPolicy()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-dataprotectionpolicy

getDeliveryStatusLogging

@Stability(Stable)
@Nullable
default Object getDeliveryStatusLogging()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-deliverystatuslogging

getDisplayName

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

The display name to use for an Amazon SNS topic with SMS subscriptions.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-displayname

getFifoTopic

@Stability(Stable)
@Nullable
default Object getFifoTopic()

Set to true to create a FIFO topic.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-fifotopic

getKmsMasterKeyId

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

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

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-kmsmasterkeyid

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.

By default, SignatureVersion is set to 1 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-signatureversion

getSubscription

@Stability(Stable)
@Nullable
default Object getSubscription()

The Amazon SNS 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-subscription

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-tags

getTopicName

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

The name of the topic you want to create.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-topicname

getTracingConfig

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

Tracing mode of an Amazon SNS topic.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-tracingconfig

builder

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

Returns:

a CfnTopicProps.Builder of CfnTopicProps