aws-cdk-lib.aws_sns.SubscriptionProps

interface SubscriptionProps

LanguageType name
.NETAmazon.CDK.AWS.SNS.SubscriptionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssns#SubscriptionProps
Javasoftware.amazon.awscdk.services.sns.SubscriptionProps
Pythonaws_cdk.aws_sns.SubscriptionProps
TypeScript (source)aws-cdk-lib » aws_sns » SubscriptionProps

Properties for creating a new subscription.

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

Properties

NameTypeDescription
endpointstringThe subscription endpoint.
protocolSubscriptionProtocolWhat type of subscription to add.
topicITopicThe topic to subscribe to.
deadLetterQueue?IQueueQueue to be used as dead letter queue.
filterPolicy?{ [string]: SubscriptionFilter }The filter policy.
filterPolicyWithMessageBody?{ [string]: FilterOrPolicy }The filter policy that is applied on the message body.
rawMessageDelivery?booleantrue if raw message delivery is enabled for the subscription.
region?stringThe region where the topic resides, in the case of cross-region subscriptions.
subscriptionRoleArn?stringArn 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.


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.