interface SnsEventSourceProps

Language	Type name
.NET	Amazon.CDK.AWS.Lambda.EventSources.SnsEventSourceProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslambdaeventsources#SnsEventSourceProps
Java	software.amazon.awscdk.services.lambda.eventsources.SnsEventSourceProps
Python	aws_cdk.aws_lambda_event_sources.SnsEventSourceProps
TypeScript (source)	aws-cdk-lib » aws_lambda_event_sources » SnsEventSourceProps

Properties forwarded to the Lambda Subscription.

Example

import * as sns from 'aws-cdk-lib/aws-sns';
import { SnsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';

declare const topic: sns.Topic;
const deadLetterQueue = new sqs.Queue(this, 'deadLetterQueue');

declare const fn: lambda.Function;
fn.addEventSource(new SnsEventSource(topic, {
  filterPolicy: { },
  deadLetterQueue: deadLetterQueue,
}));

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.

---

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.