aws-cdk-lib.aws_sns_subscriptions.LambdaSubscription

class LambdaSubscription

LanguageType name
.NETAmazon.CDK.AWS.SNS.Subscriptions.LambdaSubscription
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssnssubscriptions#LambdaSubscription
Javasoftware.amazon.awscdk.services.sns.subscriptions.LambdaSubscription
Pythonaws_cdk.aws_sns_subscriptions.LambdaSubscription
TypeScript (source)aws-cdk-lib » aws_sns_subscriptions » LambdaSubscription

Implements ITopicSubscription

Use a Lambda function as a subscription target.

Example

import * as lambda from 'aws-cdk-lib/aws-lambda';

const myTopic = new sns.Topic(this, 'MyTopic');
declare const fn: lambda.Function;

// Lambda should receive only message matching the following conditions on message body:
// color: 'red' or 'orange'
myTopic.addSubscription(new subscriptions.LambdaSubscription(fn, {
  filterPolicyWithMessageBody: {
    background: sns.FilterOrPolicy.policy({
      color: sns.FilterOrPolicy.filter(sns.SubscriptionFilter.stringFilter({
        allowlist: ['red', 'orange'],
      })),
    }),
  },
}));

Initializer

new LambdaSubscription(fn: IFunction, props?: LambdaSubscriptionProps)

Parameters

  • fn IFunction
  • props LambdaSubscriptionProps

Methods

NameDescription
bind(topic)Returns a configuration for a Lambda function to subscribe to an SNS topic.

bind(topic)

public bind(topic: ITopic): TopicSubscriptionConfig

Parameters

  • topic ITopic

Returns

  • TopicSubscriptionConfig

Returns a configuration for a Lambda function to subscribe to an SNS topic.