@aws-cdk/aws-sns

constructor

constructor(scope: cdk.Construct, id: string, props: CfnSubscriptionProps);

• Create a new AWS::SNS::Subscription.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property deliveryPolicy

deliveryPolicy: any;

• The delivery policy JSON assigned to the subscription. Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the *Amazon SNS API Reference* and [Message delivery retries](https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html) in the *Amazon SNS Developer Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-deliverypolicy

property endpoint

endpoint: string;

• The subscription's endpoint. The endpoint value depends on the protocol that you specify. For more information, see the Endpoint parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the *Amazon SNS API Reference* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-endpoint

property filterPolicy

filterPolicy: any;

• The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the *Amazon SNS API Reference* and [Message filtering](https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) in the *Amazon SNS Developer Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy

property filterPolicyScope

filterPolicyScope: string;

• This attribute lets you choose the filtering scope by using one of the following string value types:

  - MessageAttributes (default) - The filter is applied on the message attributes. - MessageBody - The filter is applied on the message body.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicyscope

property protocol

protocol: string;

• The subscription's protocol. For more information, see the Protocol parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the *Amazon SNS API Reference* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-protocol

property rawMessageDelivery

rawMessageDelivery: any;

• When set to true , enables raw message delivery. Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the *Amazon SNS API Reference* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-rawmessagedelivery

property redrivePolicy

redrivePolicy: any;

• When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

  For more information about the redrive policy and dead-letter queues, see [Amazon SQS dead-letter queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) in the *Amazon SQS Developer Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy

property region

region: string;

• For cross-region subscriptions, the region in which the topic resides.

  If no region is specified, AWS CloudFormation uses the region of the caller as the default.

  If you perform an update operation that only updates the Region property of a AWS::SNS::Subscription resource, that operation will fail unless you are either:

  - Updating the Region from NULL to the caller region. - Updating the Region from the caller region to NULL .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region

property subscriptionRoleArn

subscriptionRoleArn: string;

• This property applies only to Amazon Kinesis Data Firehose delivery stream subscriptions. Specify the ARN of the IAM role that has the following:

  - Permission to write to the Amazon Kinesis Data Firehose delivery stream - Amazon SNS listed as a trusted entity

  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see [Fanout to Amazon Kinesis Data Firehose delivery streams](https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in the *Amazon SNS Developer Guide.*

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-subscriptionrolearn

property topicArn

topicArn: string;

• The ARN of the topic to subscribe to.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnTopicProps);

• Create a new AWS::SNS::Topic.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrTopicArn

readonly attrTopicArn: string;

• Returns the ARN of an Amazon SNS topic. TopicArn

property attrTopicName

readonly attrTopicName: string;

• Returns the name of an Amazon SNS topic. TopicName

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property contentBasedDeduplication

contentBasedDeduplication: any;

• 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](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) 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.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-contentbaseddeduplication

property dataProtectionPolicy

dataProtectionPolicy: any;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-dataprotectionpolicy

property displayName

displayName: string;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-displayname

property fifoTopic

fifoTopic: any;

• Set to true to create a FIFO topic.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-fifotopic

property kmsMasterKeyId

kmsMasterKeyId: string;

• The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-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](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-kmsmasterkeyid

property signatureVersion

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. By default, SignatureVersion is set to 1 .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-signatureversion

property subscription

subscription: any;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-subscription

property tags

readonly tags: cdk.TagManager;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-tags

property topicName

topicName: string;

• 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-topicname

property tracingConfig

tracingConfig: string;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-tracingconfig

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnTopicPolicyProps);

• Create a new AWS::SNS::TopicPolicy.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property policyDocument

policyDocument: any;

• A policy document that contains permissions to add to the specified SNS topics.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-policydocument

property topics

topics: string[];

• The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) function to specify an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html) resource.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-topics

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: Construct, id: string, props: SubscriptionProps);

property deadLetterQueue

readonly deadLetterQueue?: IQueue;

• The DLQ associated with this subscription if present.

constructor

constructor(conditions?: any[]);

• Parameter conditions

  conditions that specify the message attributes that should be included, excluded, matched, etc.

property conditions

readonly conditions: any[];

method existsFilter

static existsFilter: () => SubscriptionFilter;

• Returns a subscription filter for attribute key matching.

method numericFilter

static numericFilter: (
    numericConditions: NumericConditions
) => SubscriptionFilter;

• Returns a subscription filter for a numeric attribute.

method stringFilter

static stringFilter: (stringConditions: StringConditions) => SubscriptionFilter;

• Returns a subscription filter for a string attribute.

constructor

constructor(scope: Construct, id: string, props?: TopicProps);

property autoCreatePolicy

protected readonly autoCreatePolicy: boolean;

property fifo

readonly fifo: boolean;

property topicArn

readonly topicArn: string;

property topicName

readonly topicName: string;

method fromTopicArn

static fromTopicArn: (scope: Construct, id: string, topicArn: string) => ITopic;

• Import an existing SNS topic provided an ARN

  Parameter scope

  The parent creating construct

  Parameter id

  The construct's name

  Parameter topicArn

  topic ARN (i.e. arn:aws:sns:us-east-2:444455556666:MyTopic)

property autoCreatePolicy

protected abstract readonly autoCreatePolicy: boolean;

• Controls automatic creation of policy objects.

  Set by subclasses.

property fifo

abstract readonly fifo: boolean;

property topicArn

abstract readonly topicArn: string;

property topicName

abstract readonly topicName: string;

method addSubscription

addSubscription: (subscription: ITopicSubscription) => void;

• Subscribe some endpoint to this topic

method addToResourcePolicy

addToResourcePolicy: (
    statement: iam.PolicyStatement
) => iam.AddToResourcePolicyResult;

• Adds a statement to the IAM resource policy associated with this topic.

  If this topic was created in this stack (new Topic), a topic policy will be automatically created upon the first call to addToPolicy. If the topic is imported (Topic.import), then this is a no-op.

method bindAsNotificationRuleTarget

bindAsNotificationRuleTarget: (
    _scope: constructs.Construct
) => notifications.NotificationRuleTargetConfig;

• Represents a notification target That allows SNS topic to associate with this rule target.

method grantPublish

grantPublish: (grantee: iam.IGrantable) => iam.Grant;

• Grant topic publishing permissions to the given identity

method validate

protected validate: () => string[];

constructor

constructor(scope: Construct, id: string, props: TopicPolicyProps);

property document

readonly document: PolicyDocument;

• The IAM policy document for this policy.

property start

readonly start: number;

• The start value.

property stop

readonly stop: number;

• The stop value.

property deliveryPolicy

readonly deliveryPolicy?: any | cdk.IResolvable;

• The delivery policy JSON assigned to the subscription. Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the *Amazon SNS API Reference* and [Message delivery retries](https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html) in the *Amazon SNS Developer Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-deliverypolicy

property endpoint

readonly endpoint?: string;

• The subscription's endpoint. The endpoint value depends on the protocol that you specify. For more information, see the Endpoint parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the *Amazon SNS API Reference* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-endpoint

property filterPolicy

readonly filterPolicy?: any | cdk.IResolvable;

• The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the *Amazon SNS API Reference* and [Message filtering](https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) in the *Amazon SNS Developer Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy

property filterPolicyScope

readonly filterPolicyScope?: string;

• This attribute lets you choose the filtering scope by using one of the following string value types:

  - MessageAttributes (default) - The filter is applied on the message attributes. - MessageBody - The filter is applied on the message body.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicyscope

property protocol

readonly protocol: string;

• The subscription's protocol. For more information, see the Protocol parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the *Amazon SNS API Reference* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-protocol

property rawMessageDelivery

readonly rawMessageDelivery?: boolean | cdk.IResolvable;

• When set to true , enables raw message delivery. Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the *Amazon SNS API Reference* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-rawmessagedelivery

property redrivePolicy

readonly redrivePolicy?: any | cdk.IResolvable;

• When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

  For more information about the redrive policy and dead-letter queues, see [Amazon SQS dead-letter queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) in the *Amazon SQS Developer Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy

property region

readonly region?: string;

• For cross-region subscriptions, the region in which the topic resides.

  If no region is specified, AWS CloudFormation uses the region of the caller as the default.

  If you perform an update operation that only updates the Region property of a AWS::SNS::Subscription resource, that operation will fail unless you are either:

  - Updating the Region from NULL to the caller region. - Updating the Region from the caller region to NULL .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region

property subscriptionRoleArn

readonly subscriptionRoleArn?: string;

• This property applies only to Amazon Kinesis Data Firehose delivery stream subscriptions. Specify the ARN of the IAM role that has the following:

  - Permission to write to the Amazon Kinesis Data Firehose delivery stream - Amazon SNS listed as a trusted entity

  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see [Fanout to Amazon Kinesis Data Firehose delivery streams](https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in the *Amazon SNS Developer Guide.*

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-subscriptionrolearn

property topicArn

readonly topicArn: string;

• The ARN of the topic to subscribe to.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn

property policyDocument

readonly policyDocument: any | cdk.IResolvable;

• A policy document that contains permissions to add to the specified SNS topics.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-policydocument

property topics

readonly topics: string[];

• The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) function to specify an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html) resource.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-topics

property contentBasedDeduplication

readonly contentBasedDeduplication?: boolean | cdk.IResolvable;

• 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](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) 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.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-contentbaseddeduplication

property dataProtectionPolicy

readonly dataProtectionPolicy?: any | cdk.IResolvable;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-dataprotectionpolicy

property displayName

readonly displayName?: string;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-displayname

property fifoTopic

readonly fifoTopic?: boolean | cdk.IResolvable;

• Set to true to create a FIFO topic.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-fifotopic

property kmsMasterKeyId

readonly kmsMasterKeyId?: string;

• The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-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](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-kmsmasterkeyid

property signatureVersion

readonly 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. By default, SignatureVersion is set to 1 .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-signatureversion

property subscription

readonly subscription?:
    | Array<CfnTopic.SubscriptionProperty | cdk.IResolvable>
    | cdk.IResolvable;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-subscription

property tags

readonly tags?: cdk.CfnTag[];

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-tags

property topicName

readonly topicName?: string;

• 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-topicname

property tracingConfig

readonly tracingConfig?: string;

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

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-tracingconfig

property fifo

readonly fifo: boolean;

• Whether this topic is an Amazon SNS FIFO queue. If false, this is a standard topic.

property topicArn

readonly topicArn: string;

• The ARN of the topic

property topicName

readonly topicName: string;

• The name of the topic

method addSubscription

addSubscription: (subscription: ITopicSubscription) => void;

• Subscribe some endpoint to this topic

method addToResourcePolicy

addToResourcePolicy: (
    statement: iam.PolicyStatement
) => iam.AddToResourcePolicyResult;

• Adds a statement to the IAM resource policy associated with this topic.

  If this topic was created in this stack (new Topic), a topic policy will be automatically created upon the first call to addToPolicy. If the topic is imported (Topic.import), then this is a no-op.

method grantPublish

grantPublish: (identity: iam.IGrantable) => iam.Grant;

• Grant topic publishing permissions to the given identity

method metric

metric: (
    metricName: string,
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• Return the given named metric for this Topic

method metricNumberOfMessagesPublished

metricNumberOfMessagesPublished: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The number of messages published to your Amazon SNS topics.

  Sum over 5 minutes

method metricNumberOfNotificationsDelivered

metricNumberOfNotificationsDelivered: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints.

  Sum over 5 minutes

method metricNumberOfNotificationsFailed

metricNumberOfNotificationsFailed: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The number of messages that Amazon SNS failed to deliver.

  Sum over 5 minutes

method metricNumberOfNotificationsFilteredOut

metricNumberOfNotificationsFilteredOut: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The number of messages that were rejected by subscription filter policies.

  Sum over 5 minutes

method metricNumberOfNotificationsFilteredOutInvalidAttributes

metricNumberOfNotificationsFilteredOutInvalidAttributes: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid

  Sum over 5 minutes

method metricNumberOfNotificationsFilteredOutNoMessageAttributes

metricNumberOfNotificationsFilteredOutNoMessageAttributes: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The number of messages that were rejected by subscription filter policies because the messages have no attributes.

  Sum over 5 minutes

method metricPublishSize

metricPublishSize: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;

• Metric for the size of messages published through this topic

  Average over 5 minutes

method metricSMSMonthToDateSpentUSD

metricSMSMonthToDateSpentUSD: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The charges you have accrued since the start of the current calendar month for sending SMS messages.

  Maximum over 5 minutes

method metricSMSSuccessRate

metricSMSSuccessRate: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;

• The rate of successful SMS message deliveries.

  Sum over 5 minutes

method bind

bind: (topic: ITopic) => TopicSubscriptionConfig;

• Returns a configuration used to subscribe to an SNS topic

  Parameter topic

  topic for which subscription will be configured

property allowlist

readonly allowlist?: number[];

• Match one or more values.

  - None

property between

readonly between?: BetweenCondition;

• Match values that are between the specified values.

  - None

property betweenStrict

readonly betweenStrict?: BetweenCondition;

• Match values that are strictly between the specified values.

  - None

property greaterThan

readonly greaterThan?: number;

• Match values that are greater than the specified value.

  - None

property greaterThanOrEqualTo

readonly greaterThanOrEqualTo?: number;

• Match values that are greater than or equal to the specified value.

  - None

property lessThan

readonly lessThan?: number;

• Match values that are less than the specified value.

  - None

property lessThanOrEqualTo

readonly lessThanOrEqualTo?: number;

• Match values that are less than or equal to the specified value.

  - None

property whitelist

readonly whitelist?: number[];

• Match one or more values.

  Deprecated

  use allowlist - None

property allowlist

readonly allowlist?: string[];

• Match one or more values. - None

property blacklist

readonly blacklist?: string[];

• Match any value that doesn't include any of the specified values.

  Deprecated

  use denylist - None

property denylist

readonly denylist?: string[];

• Match any value that doesn't include any of the specified values. - None

property matchPrefixes

readonly matchPrefixes?: string[];

• Matches values that begins with the specified prefixes.

  - None

property whitelist

readonly whitelist?: string[];

• Match one or more values.

  Deprecated

  use allowlist - None

property deadLetterQueue

readonly deadLetterQueue?: IQueue;

• Queue to be used as dead letter queue. If not passed no dead letter queue is enabled.

  - No dead letter queue enabled.

property endpoint

readonly endpoint: string;

• The subscription endpoint.

  The meaning of this value depends on the value for 'protocol'.

property filterPolicy

readonly filterPolicy?: {
    [attribute: string]: SubscriptionFilter;
};

• The filter policy.

  - all messages are delivered

property protocol

readonly protocol: SubscriptionProtocol;

• What type of subscription to add.

property rawMessageDelivery

readonly rawMessageDelivery?: boolean;

• true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints. For more information, see GetSubscriptionAttributes in the Amazon Simple Notification Service API Reference.

  false

property region

readonly region?: string;

• The region where the topic resides, in the case of cross-region subscriptions https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region - the region where the CloudFormation stack is being deployed.

property subscriptionRoleArn

readonly subscriptionRoleArn?: string;

• Arn of role allowing access to firehose delivery stream. Required for a firehose subscription protocol. - No subscription role is provided

property topic

readonly topic: ITopic;

• The topic to subscribe to.

method metric

metric: (
    metricName: string,
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• Return the given named metric for this Topic

method metricNumberOfMessagesPublished

metricNumberOfMessagesPublished: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The number of messages published to your Amazon SNS topics.

  Sum over 5 minutes

method metricNumberOfNotificationsDelivered

metricNumberOfNotificationsDelivered: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints.

  Sum over 5 minutes

method metricNumberOfNotificationsFailed

metricNumberOfNotificationsFailed: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The number of messages that Amazon SNS failed to deliver.

  Sum over 5 minutes

method metricNumberOfNotificationsFilteredOut

metricNumberOfNotificationsFilteredOut: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The number of messages that were rejected by subscription filter policies.

  Sum over 5 minutes

method metricNumberOfNotificationsFilteredOutInvalidAttributes

metricNumberOfNotificationsFilteredOutInvalidAttributes: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid

  Sum over 5 minutes

method metricNumberOfNotificationsFilteredOutNoMessageAttributes

metricNumberOfNotificationsFilteredOutNoMessageAttributes: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The number of messages that were rejected by subscription filter policies because the messages have no attributes.

  Sum over 5 minutes

method metricPublishSize

metricPublishSize: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;

• Metric for the size of messages published through this topic

  Average over 5 minutes

method metricSMSMonthToDateSpentUSD

metricSMSMonthToDateSpentUSD: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

• The charges you have accrued since the start of the current calendar month for sending SMS messages.

  Maximum over 5 minutes

method metricSMSSuccessRate

metricSMSSuccessRate: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;

• The rate of successful SMS message deliveries.

  Sum over 5 minutes

property policyDocument

readonly policyDocument?: PolicyDocument;

• IAM policy document to apply to topic(s). empty policy document

property topics

readonly topics: ITopic[];

• The set of topics this policy applies to.

property contentBasedDeduplication

readonly contentBasedDeduplication?: boolean;

• Enables content-based deduplication for FIFO topics.

  None

property displayName

readonly displayName?: string;

• A developer-defined string that can be used to identify this SNS topic.

  None

property fifo

readonly fifo?: boolean;

• Set to true to create a FIFO topic.

  None

property masterKey

readonly masterKey?: IKey;

• A KMS Key, either managed by this CDK app, or imported.

  None

property topicName

readonly topicName?: string;

• A name for the topic.

  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.

  Generated name

property subscriberId

readonly subscriberId: string;

• The id of the SNS subscription resource created under scope. In most cases, it is recommended to use the uniqueId of the topic you are subscribing to.

property subscriberScope

readonly subscriberScope?: Construct;

• The scope in which to create the SNS subscription resource. Normally you'd want the subscription to be created on the consuming stack because the topic is usually referenced by the consumer's resource policy (e.g. SQS queue policy). Otherwise, it will cause a cyclic reference.

  If this is undefined, the subscription will be created on the topic's stack.

  - use the topic as the scope of the subscription, in which case subscriberId must be defined.

member APPLICATION

APPLICATION = 'application'

• JSON-encoded notifications are sent to a mobile app endpoint.

member EMAIL

EMAIL = 'email'

• Notifications are sent via email.

member EMAIL_JSON

EMAIL_JSON = 'email-json'

• Notifications are JSON-encoded and sent via mail.

member FIREHOSE

FIREHOSE = 'firehose'

• Notifications put records into a firehose delivery stream.

member HTTP

HTTP = 'http'

• JSON-encoded message is POSTED to an HTTP url.

member HTTPS

HTTPS = 'https'

• JSON-encoded message is POSTed to an HTTPS url.

member LAMBDA

LAMBDA = 'lambda'

• Notifications trigger a Lambda function.

member SMS

SMS = 'sms'

• Notification is delivered by SMS

member SQS

SQS = 'sqs'

• Notifications are enqueued into an SQS queue.