Package software.amazon.awscdk.services.sns

Class CfnTopic

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sns.CfnTopic
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ITopicRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:18.262Z") @Stability(Stable) public class CfnTopic extends CfnResource implements IInspectable, ITopicRef, ITaggable
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 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 archivePolicy;
 Object dataProtectionPolicy;
 CfnTopic cfnTopic = CfnTopic.Builder.create(this, "MyCfnTopic")
         .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")
         .fifoThroughputScope("fifoThroughputScope")
         .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:

  • 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 software.constructs.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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnTopic

      @Stability(Stable) public CfnTopic(@NotNull software.constructs.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 - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForTopic

      @Stability(Stable) @NotNull public static String arnForTopic(@NotNull ITopicRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnTopic

      @Stability(Stable) @NotNull public static Boolean isCfnTopic(@NotNull Object x)
      Checks whether the given object is a CfnTopic.

      Parameters:
      x - This parameter is required.

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

    • getAttrTopicName

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

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getTopicRef

      @Stability(Stable) @NotNull public TopicReference getTopicRef()
      A reference to a Topic resource.
      Specified by:
      getTopicRef in interface ITopicRef

    • getArchivePolicy

      @Stability(Stable) @Nullable public Object getArchivePolicy()
      The ArchivePolicy determines the number of days Amazon retains messages in FIFO topics.

    • setArchivePolicy

      @Stability(Stable) public void setArchivePolicy(@Nullable Object value)
      The ArchivePolicy determines the number of days Amazon retains messages in FIFO topics.

    • getContentBasedDeduplication

      @Stability(Stable) @Nullable public Object getContentBasedDeduplication()
      ContentBasedDeduplication enables deduplication of messages based on their content for FIFO topics.

      Returns union: either Boolean or IResolvable

    • setContentBasedDeduplication

      @Stability(Stable) public void setContentBasedDeduplication(@Nullable Boolean value)
      ContentBasedDeduplication enables deduplication of messages based on their content for FIFO topics.

    • setContentBasedDeduplication

      @Stability(Stable) public void setContentBasedDeduplication(@Nullable IResolvable value)
      ContentBasedDeduplication enables deduplication of messages based on their content for FIFO topics.

    • getDataProtectionPolicy

      @Stability(Stable) @Nullable public Object getDataProtectionPolicy()
      The body of the policy document you want to use for this topic.

    • setDataProtectionPolicy

      @Stability(Stable) public void setDataProtectionPolicy(@Nullable Object value)
      The body of the policy document you want to use for this topic.

    • getDeliveryStatusLogging

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

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTopic.LoggingConfigProperty>

    • setDeliveryStatusLogging

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

    • setDeliveryStatusLogging

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

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The display name to use for an Amazon topic with SMS subscriptions.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The display name to use for an Amazon topic with SMS subscriptions.

    • getFifoThroughputScope

      @Stability(Stable) @Nullable public String getFifoThroughputScope()
      Specifies the throughput quota and deduplication behavior to apply for the FIFO topic.

    • setFifoThroughputScope

      @Stability(Stable) public void setFifoThroughputScope(@Nullable String value)
      Specifies the throughput quota and deduplication behavior to apply for the FIFO topic.

    • getFifoTopic

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

      Returns union: either Boolean or IResolvable

    • 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 or a custom CMK.

    • setKmsMasterKeyId

      @Stability(Stable) public void setKmsMasterKeyId(@Nullable String value)
      The ID of an AWS managed customer master key (CMK) for Amazon or a custom CMK.

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

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

    • getSubscription

      @Stability(Stable) @Nullable public Object getSubscription()
      The Amazon subscriptions (endpoints) for this topic.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTopic.SubscriptionProperty>

    • setSubscription

      @Stability(Stable) public void setSubscription(@Nullable IResolvable value)
      The Amazon subscriptions (endpoints) for this topic.

    • setSubscription

      @Stability(Stable) public void setSubscription(@Nullable List<Object> value)
      The Amazon subscriptions (endpoints) for this topic.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The list of tags to add to a new topic.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The list of tags to add to a new topic.

    • getTopicName

      @Stability(Stable) @Nullable public String getTopicName()
      The name of the topic you want to create.

    • setTopicName

      @Stability(Stable) public void setTopicName(@Nullable String value)
      The name of the topic you want to create.

    • getTracingConfig

      @Stability(Stable) @Nullable public String getTracingConfig()
      Tracing mode of an Amazon topic.

    • setTracingConfig

      @Stability(Stable) public void setTracingConfig(@Nullable String value)
      Tracing mode of an Amazon topic.