interface SubscriptionProps

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

Options to subscribing to an SNS topic.

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 sns_subscriptions from '@aws-cdk/aws-sns-subscriptions';
import * as sqs from '@aws-cdk/aws-sqs';

declare const queue: sqs.Queue;
declare const subscriptionFilter: sns.SubscriptionFilter;
const subscriptionProps: sns_subscriptions.SubscriptionProps = {
  deadLetterQueue: queue,
  filterPolicy: {
    filterPolicyKey: subscriptionFilter,
  },
};

Properties

Name	Type	Description
deadLetterQueue?	IQueue	Queue to be used as dead letter queue.
filterPolicy?	{ [string]: SubscriptionFilter }	The filter policy.

---

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.