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.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.166Z") @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 dataProtectionPolicy;
 CfnTopicProps cfnTopicProps = CfnTopicProps.builder()
         .contentBasedDeduplication(false)
         .dataProtectionPolicy(dataProtectionPolicy)
         .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();

  • Method Details

    • 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.

    • 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.

    • 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.

    • getFifoTopic

      @Stability(Stable) @Nullable default Object getFifoTopic()
      Set to true to create a FIFO topic.

    • 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 .

    • 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 .

    • 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.

    • 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.

    • 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.

    • 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 SNS publisher to its subscriptions. If set to Active , SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. Only supported on standard topics.

    • builder

      @Stability(Stable) static CfnTopicProps.Builder builder()
      Returns:
      a CfnTopicProps.Builder of CfnTopicProps