Package software.amazon.awscdk.services.sns.subscriptions

Class LambdaSubscription

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.sns.subscriptions.LambdaSubscription

All Implemented Interfaces:

ITopicSubscription, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-12T12:32:11.493Z")
@Stability(Stable)
public class LambdaSubscription
extends software.amazon.jsii.JsiiObject
implements ITopicSubscription

Use a Lambda function as a subscription target.

Example:

 import software.amazon.awscdk.services.lambda.*;
 Function fn;
 Topic myTopic = new Topic(this, "MyTopic");
 // Lambda should receive only message matching the following conditions on message body:
 // color: 'red' or 'orange'
 myTopic.addSubscription(LambdaSubscription.Builder.create(fn)
         .filterPolicyWithMessageBody(Map.of(
                 "background", FilterOrPolicy.policy(Map.of(
                         "color", FilterOrPolicy.filter(SubscriptionFilter.stringFilter(StringConditions.builder()
                                 .allowlist(List.of("red", "orange"))
                                 .build()))))))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LambdaSubscription.Builder	A fluent builder for LambdaSubscription.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sns.ITopicSubscription

ITopicSubscription.Jsii$Default, ITopicSubscription.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	LambdaSubscription(IFunction fn)
	LambdaSubscription(IFunction fn, LambdaSubscriptionProps props)
protected	LambdaSubscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LambdaSubscription(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
TopicSubscriptionConfig	bind(ITopic topic)	Returns a configuration for a Lambda function to subscribe to an SNS topic.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

LambdaSubscription

protected LambdaSubscription(software.amazon.jsii.JsiiObjectRef objRef)

LambdaSubscription

protected LambdaSubscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

LambdaSubscription

@Stability(Stable)
public LambdaSubscription(@NotNull
 IFunction fn,
 @Nullable
 LambdaSubscriptionProps props)

Parameters:

fn - This parameter is required.

props -

LambdaSubscription

@Stability(Stable)
public LambdaSubscription(@NotNull
 IFunction fn)

Parameters:

fn - This parameter is required.

Method Details

bind

@Stability(Stable)
@NotNull
public TopicSubscriptionConfig bind(@NotNull
 ITopic topic)

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

Specified by:

bind in interface ITopicSubscription

Parameters:

topic - This parameter is required.