class Subscription (construct)

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

Implements IConstruct, IDependable, IResource

A new subscription.

Prefer to use the ITopic.addSubscription() methods to create instances of this class.

Example

import { DeliveryStream } from '@aws-cdk/aws-kinesisfirehose-alpha';

const topic = new sns.Topic(this, 'Topic');
declare const stream: DeliveryStream;

new sns.Subscription(this, 'Subscription', {
  topic,
  endpoint: stream.deliveryStreamArn,
  protocol: sns.SubscriptionProtocol.FIREHOSE,
  subscriptionRoleArn: "SAMPLE_ARN", //role with permissions to send messages to a firehose delivery stream
});

Initializer

new Subscription(scope: Construct, id: string, props: SubscriptionProps)

Parameters

• scope Construct
• id string
• props SubscriptionProps

Construct Props

Name	Type	Description
endpoint	string	The subscription endpoint.
protocol	SubscriptionProtocol	What type of subscription to add.
topic	ITopic	The topic to subscribe to.
deadLetterQueue?	IQueue	Queue to be used as dead letter queue.
deliveryPolicy?	DeliveryPolicy	The delivery policy.
filterPolicy?	{ [string]: SubscriptionFilter }	The filter policy.
filterPolicyWithMessageBody?	{ [string]: FilterOrPolicy }	The filter policy that is applied on the message body.
rawMessageDelivery?	boolean	true if raw message delivery is enabled for the subscription.
region?	string	The region where the topic resides, in the case of cross-region subscriptions.
subscriptionRoleArn?	string	Arn of role allowing access to firehose delivery stream.

---

endpoint

Type: string

The subscription endpoint.

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

---

protocol

Type: SubscriptionProtocol

What type of subscription to add.

---

topic

Type: ITopic

The topic to subscribe to.

---

deadLetterQueue?

Type: IQueue (optional, default: No dead letter queue enabled.)

Queue to be used as dead letter queue.

If not passed no dead letter queue is enabled.

---

deliveryPolicy?

Type: DeliveryPolicy (optional, default: if the initial delivery of the message fails, three retries with a delay between failed attempts set at 20 seconds)

The delivery policy.

---

filterPolicy?

Type: { [string]: SubscriptionFilter } (optional, default: all messages are delivered)

The filter policy.

---

filterPolicyWithMessageBody?

Type: { [string]: FilterOrPolicy } (optional, default: all messages are delivered)

The filter policy that is applied on the message body.

To apply a filter policy to the message attributes, use filterPolicy. A maximum of one of filterPolicyWithMessageBody and filterPolicy may be used.

---

rawMessageDelivery?

Type: boolean (optional, default: false)

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.

---

region?

Type: string (optional, default: the region where the CloudFormation stack is being deployed.)

The region where the topic resides, in the case of cross-region subscriptions.

---

subscriptionRoleArn?

Type: string (optional, default: No subscription role is provided)

Arn of role allowing access to firehose delivery stream.

Required for a firehose subscription protocol.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
deadLetterQueue?	IQueue	The DLQ associated with this subscription if present.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

deadLetterQueue?

Type: IQueue (optional)

The DLQ associated with this subscription if present.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

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

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.