interface SqsSubscriptionProps

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

Properties for an SQS subscription.

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';
import { aws_sns_subscriptions as sns_subscriptions } from 'aws-cdk-lib';
import { aws_sqs as sqs } from 'aws-cdk-lib';

declare const filterOrPolicy: sns.FilterOrPolicy;
declare const queue: sqs.Queue;
declare const subscriptionFilter: sns.SubscriptionFilter;
const sqsSubscriptionProps: sns_subscriptions.SqsSubscriptionProps = {
  deadLetterQueue: queue,
  filterPolicy: {
    filterPolicyKey: subscriptionFilter,
  },
  filterPolicyWithMessageBody: {
    filterPolicyWithMessageBodyKey: filterOrPolicy,
  },
  rawMessageDelivery: false,
};

Properties

Name	Type	Description
deadLetterQueue?	IQueue	Queue 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?	boolean	The message to the queue is the same as it was sent to the topic.

---

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)

The message to the queue is the same as it was sent to the topic.

If false, the message will be wrapped in an SNS envelope.