class CfnSubscription (construct)

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

Implements IConstruct, IDependable, IInspectable

The AWS::SNS::Subscription resource subscribes an endpoint to an Amazon SNS topic.

For a subscription to be created, the owner of the endpoint must` confirm the subscription.

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

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 deliveryPolicy: any;
declare const filterPolicy: any;
declare const redrivePolicy: any;
declare const replayPolicy: any;
const cfnSubscription = new sns.CfnSubscription(this, 'MyCfnSubscription', {
  protocol: 'protocol',
  topicArn: 'topicArn',

  // the properties below are optional
  deliveryPolicy: deliveryPolicy,
  endpoint: 'endpoint',
  filterPolicy: filterPolicy,
  filterPolicyScope: 'filterPolicyScope',
  rawMessageDelivery: false,
  redrivePolicy: redrivePolicy,
  region: 'region',
  replayPolicy: replayPolicy,
  subscriptionRoleArn: 'subscriptionRoleArn',
});

Initializer

new CfnSubscription(scope: Construct, id: string, props: CfnSubscriptionProps)

Parameters

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

Construct Props

Name	Type	Description
protocol	string	The subscription's protocol.
topicArn	string	The ARN of the topic to subscribe to.
deliveryPolicy?	any	The delivery policy JSON assigned to the subscription.
endpoint?	string	The subscription's endpoint.
filterPolicy?	any	The filter policy JSON assigned to the subscription.
filterPolicyScope?	string	This attribute lets you choose the filtering scope by using one of the following string value types:.
rawMessageDelivery?	boolean | IResolvable	When set to true , enables raw message delivery.
redrivePolicy?	any	When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.
region?	string	For cross-region subscriptions, the region in which the topic resides.
replayPolicy?	any	Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.
subscriptionRoleArn?	string	This property applies only to Amazon Data Firehose delivery stream subscriptions.

---

protocol

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

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

---

topicArn

Type: string

The ARN of the topic to subscribe to.

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

---

deliveryPolicy?

Type: any (optional)

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 in the Amazon SNS Developer Guide .

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

---

endpoint?

Type: string (optional)

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 .

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

---

filterPolicy?

Type: any (optional)

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 in the Amazon SNS Developer Guide .

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

---

filterPolicyScope?

Type: string (optional)

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.

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

---

rawMessageDelivery?

Type: boolean | IResolvable (optional)

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 .

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

---

redrivePolicy?

Type: any (optional)

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 in the Amazon SQS Developer Guide .

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

---

region?

Type: string (optional)

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 .

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

---

replayPolicy?

Type: any (optional)

Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.

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

---

subscriptionRoleArn?

Type: string (optional)

This property applies only to Amazon Data Firehose delivery stream subscriptions.

Specify the ARN of the IAM role that has the following:

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

Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Amazon Data Firehose delivery streams in the Amazon SNS Developer Guide.

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

Properties

Name	Type	Description
attrArn	string	Arn of the subscription.
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.
protocol	string	The subscription's protocol.
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.
topicArn	string	The ARN of the topic to subscribe to.
deliveryPolicy?	any	The delivery policy JSON assigned to the subscription.
endpoint?	string	The subscription's endpoint.
filterPolicy?	any	The filter policy JSON assigned to the subscription.
filterPolicyScope?	string	This attribute lets you choose the filtering scope by using one of the following string value types:.
rawMessageDelivery?	boolean | IResolvable	When set to true , enables raw message delivery.
redrivePolicy?	any	When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.
region?	string	For cross-region subscriptions, the region in which the topic resides.
replayPolicy?	any	Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.
subscriptionRoleArn?	string	This property applies only to Amazon Data Firehose delivery stream subscriptions.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrArn

Type: string

Arn of the subscription.

---

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.

---

protocol

Type: string

The subscription's protocol.

---

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

---

topicArn

Type: string

The ARN of the topic to subscribe to.

---

deliveryPolicy?

Type: any (optional)

The delivery policy JSON assigned to the subscription.

---

endpoint?

Type: string (optional)

The subscription's endpoint.

---

filterPolicy?

Type: any (optional)

The filter policy JSON assigned to the subscription.

---

filterPolicyScope?

Type: string (optional)

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

---

rawMessageDelivery?

Type: boolean | IResolvable (optional)

When set to true , enables raw message delivery.

---

redrivePolicy?

Type: any (optional)

When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.

---

region?

Type: string (optional)

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

---

replayPolicy?

Type: any (optional)

Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.

---

subscriptionRoleArn?

Type: string (optional)

This property applies only to Amazon Data Firehose delivery stream subscriptions.

---

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.

See also: [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.](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:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

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.

See also: [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.](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.)

---

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