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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.238Z")
 @Stability(value=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 dataProtectionPolicy;
 CfnTopicProps cfnTopicProps = CfnTopicProps.builder()
         .contentBasedDeduplication(false)
         .dataProtectionPolicy(dataProtectionPolicy)
         .displayName("displayName")
         .fifoTopic(false)
         .kmsMasterKeyId("kmsMasterKeyId")
         .subscription(List.of(SubscriptionProperty.builder()
                 .endpoint("endpoint")
                 .protocol("protocol")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .topicName("topicName")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnTopicProps.Builder	builder()
default Object	getContentBasedDeduplication() Enables content-based deduplication for FIFO topics.
default Object	getDataProtectionPolicy() `AWS::SNS::Topic.DataProtectionPolicy`.
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 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContentBasedDeduplication

@Stability(value=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.

getDataProtectionPolicy

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

`AWS::SNS::Topic.DataProtectionPolicy`.

getDisplayName

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

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

getFifoTopic

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

Set to true to create a FIFO topic.

getKmsMasterKeyId

@Stability(value=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 .

getSubscription

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

The Amazon SNS subscriptions (endpoints) for this topic.

getTags

@Stability(value=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.

getTopicName

@Stability(value=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.

builder

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

Returns:

a CfnTopicProps.Builder of CfnTopicProps