class CfnTopic (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.SNS.CfnTopic`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssns#CfnTopic`
Java	`software.amazon.awscdk.services.sns.CfnTopic`
Python	`aws_cdk.aws_sns.CfnTopic`
TypeScript	`aws-cdk-lib` » `aws_sns` » `CfnTopic`

Implements IConstruct, IDependable, IInspectable, 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 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 { aws_sns as sns } from 'aws-cdk-lib';

declare const archivePolicy: any;
declare const dataProtectionPolicy: any;
const cfnTopic = new sns.CfnTopic(this, 'MyCfnTopic', /* all optional props */ {
  archivePolicy: archivePolicy,
  contentBasedDeduplication: false,
  dataProtectionPolicy: dataProtectionPolicy,
  deliveryStatusLogging: [{
    protocol: 'protocol',

    // the properties below are optional
    failureFeedbackRoleArn: 'failureFeedbackRoleArn',
    successFeedbackRoleArn: 'successFeedbackRoleArn',
    successFeedbackSampleRate: 'successFeedbackSampleRate',
  }],
  displayName: 'displayName',
  fifoTopic: false,
  kmsMasterKeyId: 'kmsMasterKeyId',
  signatureVersion: 'signatureVersion',
  subscription: [{
    endpoint: 'endpoint',
    protocol: 'protocol',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  topicName: 'topicName',
  tracingConfig: 'tracingConfig',
});

Initializer

new CfnTopic(scope: Construct, id: string, props?: CfnTopicProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnTopicProps — Resource properties.

Construct Props

Name	Type	Description
archivePolicy?	`any`	The `ArchivePolicy` determines the number of days Amazon SNS retains messages in FIFO topics.
contentBasedDeduplication?	`boolean \|` `IResolvable`	`ContentBasedDeduplication` enables deduplication of messages based on their content for FIFO topics.
dataProtectionPolicy?	`any`	The body of the policy document you want to use for this topic.
deliveryStatusLogging?	`IResolvable` `\|` `IResolvable` `\|` `LoggingConfigProperty[]`	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:.
displayName?	`string`	The display name to use for an Amazon SNS topic with SMS subscriptions.
fifoTopic?	`boolean \|` `IResolvable`	Set to true to create a FIFO topic.
kmsMasterKeyId?	`string`	The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK.
signatureVersion?	`string`	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.
subscription?	`IResolvable` `\|` `IResolvable` `\|` `SubscriptionProperty[]`	The Amazon SNS subscriptions (endpoints) for this topic.
tags?	`CfnTag[]`	The list of tags to add to a new topic.
topicName?	`string`	The name of the topic you want to create.
tracingConfig?	`string`	Tracing mode of an Amazon SNS topic.

archivePolicy?

Type: any (optional)

The ArchivePolicy determines the number of days Amazon SNS retains messages in FIFO topics.

You can set a retention period ranging from 1 to 365 days. This property is only applicable to FIFO topics; attempting to use it with standard topics will result in a creation failure.

contentBasedDeduplication?

Type: boolean | IResolvable (optional)

ContentBasedDeduplication enables deduplication of messages based on their content for FIFO topics.

By default, this property is set to false. If you create a FIFO topic with ContentBasedDeduplication set to false, you must provide a MessageDeduplicationId for each Publish action. When set to true, Amazon SNS automatically generates a MessageDeduplicationId using a SHA-256 hash of the message body (excluding message attributes). You can optionally override this generated value by specifying a MessageDeduplicationId in the Publish action. Note that this property only applies to FIFO topics; using it with standard topics will cause the creation to fail.

dataProtectionPolicy?

Type: any (optional)

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.

deliveryStatusLogging?

Type: IResolvable | IResolvable | LoggingConfigProperty[] (optional)

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.

displayName?

Type: string (optional)

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.

fifoTopic?

Type: boolean | IResolvable (optional)

Set to true to create a FIFO topic.

kmsMasterKeyId?

Type: string (optional)

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 .

signatureVersion?

Type: string (optional)

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 .

subscription?

Type: IResolvable | IResolvable | SubscriptionProperty[] (optional)

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.

tags?

Type: CfnTag[] (optional)

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.

topicName?

Type: string (optional)

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.

tracingConfig?

Type: string (optional)

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.

Properties

Name	Type	Description
attrTopicArn	`string`	Returns the ARN of an Amazon SNS topic.
attrTopicName	`string`	Returns the name of an Amazon SNS topic.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
archivePolicy?	`any`	The `ArchivePolicy` determines the number of days Amazon SNS retains messages in FIFO topics.
contentBasedDeduplication?	`boolean \|` `IResolvable`	`ContentBasedDeduplication` enables deduplication of messages based on their content for FIFO topics.
dataProtectionPolicy?	`any`	The body of the policy document you want to use for this topic.
deliveryStatusLogging?	`IResolvable` `\|` `IResolvable` `\|` `LoggingConfigProperty[]`	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:.
displayName?	`string`	The display name to use for an Amazon SNS topic with SMS subscriptions.
fifoTopic?	`boolean \|` `IResolvable`	Set to true to create a FIFO topic.
kmsMasterKeyId?	`string`	The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK.
signatureVersion?	`string`	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.
subscription?	`IResolvable` `\|` `IResolvable` `\|` `SubscriptionProperty[]`	The Amazon SNS subscriptions (endpoints) for this topic.
tagsRaw?	`CfnTag[]`	The list of tags to add to a new topic.
topicName?	`string`	The name of the topic you want to create.
tracingConfig?	`string`	Tracing mode of an Amazon SNS topic.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrTopicArn

Type: string

Returns the ARN of an Amazon SNS topic.

attrTopicName

Type: string

Returns the name of an Amazon SNS topic.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

archivePolicy?

Type: any (optional)

The ArchivePolicy determines the number of days Amazon SNS retains messages in FIFO topics.

contentBasedDeduplication?

Type: boolean | IResolvable (optional)

ContentBasedDeduplication enables deduplication of messages based on their content for FIFO topics.

dataProtectionPolicy?

Type: any (optional)

The body of the policy document you want to use for this topic.

deliveryStatusLogging?

Type: IResolvable | IResolvable | LoggingConfigProperty[] (optional)

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

displayName?

Type: string (optional)

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

fifoTopic?

Type: boolean | IResolvable (optional)

Set to true to create a FIFO topic.

kmsMasterKeyId?

Type: string (optional)

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

signatureVersion?

Type: string (optional)

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.

subscription?

Type: IResolvable | IResolvable | SubscriptionProperty[] (optional)

The Amazon SNS subscriptions (endpoints) for this topic.

tagsRaw?

Type: CfnTag[] (optional)

The list of tags to add to a new topic.

topicName?

Type: string (optional)

The name of the topic you want to create.

tracingConfig?

Type: string (optional)

Tracing mode of an Amazon SNS topic.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }