interface SubscriptionOptions

Language	Type name
.NET	Amazon.CDK.AWS.SNS.SubscriptionOptions
Java	software.amazon.awscdk.services.sns.SubscriptionOptions
Python	aws_cdk.aws_sns.SubscriptionOptions
TypeScript (source)	@aws-cdk/aws-sns » SubscriptionOptions

Options for creating a new subscription.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as sns from '@aws-cdk/aws-sns';
import * as sqs from '@aws-cdk/aws-sqs';

declare const queue: sqs.Queue;
declare const subscriptionFilter: sns.SubscriptionFilter;
const subscriptionOptions: sns.SubscriptionOptions = {
  endpoint: 'endpoint',
  protocol: sns.SubscriptionProtocol.HTTP,

  // the properties below are optional
  deadLetterQueue: queue,
  filterPolicy: {
    filterPolicyKey: subscriptionFilter,
  },
  rawMessageDelivery: false,
  region: 'region',
  subscriptionRoleArn: 'subscriptionRoleArn',
};

Properties

Name	Type	Description
endpoint	string	The subscription endpoint.
protocol	SubscriptionProtocol	What type of subscription to add.
deadLetterQueue?	IQueue	Queue to be used as dead letter queue.
filterPolicy?	{ [string]: SubscriptionFilter }	The filter policy.
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.

---

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.

---

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.