Package software.amazon.awscdk.services.sns

Class CfnTopic

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.sns.CfnTopic
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.159Z") @Stability(Stable) public class CfnTopic extends CfnResource implements IInspectable
A CloudFormation AWS::SNS::Topic.

The AWS::SNS::Topic resource creates a topic to which notifications can be published.

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see Amazon SNS endpoints and quotas in the AWS General Reference .

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;
 CfnTopic cfnTopic = CfnTopic.Builder.create(this, "MyCfnTopic")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTopic

      protected CfnTopic(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTopic

      protected CfnTopic(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTopic

      @Stability(Stable) public CfnTopic(@NotNull Construct scope, @NotNull String id, @Nullable CfnTopicProps props)
      Create a new AWS::SNS::Topic.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnTopic

      @Stability(Stable) public CfnTopic(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::SNS::Topic.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrTopicArn

      @Stability(Stable) @NotNull public String getAttrTopicArn()
      Returns the ARN of an Amazon SNS topic.

    • getAttrTopicName

      @Stability(Stable) @NotNull public String getAttrTopicName()
      Returns the name of an Amazon SNS topic.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager 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.

    • getDataProtectionPolicy

      @Stability(Stable) @NotNull public 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.

    • setDataProtectionPolicy

      @Stability(Stable) public void setDataProtectionPolicy(@NotNull Object value)
      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.

    • getContentBasedDeduplication

      @Stability(Stable) @Nullable public 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.

    • setContentBasedDeduplication

      @Stability(Stable) public void setContentBasedDeduplication(@Nullable Boolean value)
      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.

    • setContentBasedDeduplication

      @Stability(Stable) public void setContentBasedDeduplication(@Nullable IResolvable value)
      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.

    • getDisplayName

      @Stability(Stable) @Nullable public 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.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      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 public Object getFifoTopic()
      Set to true to create a FIFO topic.

    • setFifoTopic

      @Stability(Stable) public void setFifoTopic(@Nullable Boolean value)
      Set to true to create a FIFO topic.

    • setFifoTopic

      @Stability(Stable) public void setFifoTopic(@Nullable IResolvable value)
      Set to true to create a FIFO topic.

    • getKmsMasterKeyId

      @Stability(Stable) @Nullable public 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 .

    • setKmsMasterKeyId

      @Stability(Stable) public void setKmsMasterKeyId(@Nullable String value)
      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 public 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 .

    • setSignatureVersion

      @Stability(Stable) public void setSignatureVersion(@Nullable String value)
      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 public 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.

    • setSubscription

      @Stability(Stable) public void setSubscription(@Nullable IResolvable value)
      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.

    • setSubscription

      @Stability(Stable) public void setSubscription(@Nullable List<Object> value)
      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.

    • getTopicName

      @Stability(Stable) @Nullable public 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.

    • setTopicName

      @Stability(Stable) public void setTopicName(@Nullable String value)
      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 public 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.

    • setTracingConfig

      @Stability(Stable) public void setTracingConfig(@Nullable String value)
      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.