software.amazon.awscdk.services.lambda

Class EventSourceMapping

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.lambda.EventSourceMapping

All Implemented Interfaces:

IResource, IEventSourceMapping, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:21.512Z")
 @Stability(value=Experimental)
public class EventSourceMapping
extends Resource
implements IEventSourceMapping

(experimental) Defines a Lambda EventSourceMapping resource.

Usually, you won't need to define the mapping yourself. This will usually be done by event sources. For example, to add an SQS event source to a function:

 import { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources';
 lambda.addEventSource(new SqsEventSource(sqs));
 

The SqsEventSource class will automatically create the mapping, and will also modify the Lambda's execution role so it can consume messages from the queue.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventSourceMapping.Builder (experimental) A fluent builder for EventSourceMapping.

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.lambda.IEventSourceMapping

IEventSourceMapping.Jsii$Default, IEventSourceMapping.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	EventSourceMapping(software.constructs.Construct scope, String id, EventSourceMappingProps props)
protected	EventSourceMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	EventSourceMapping(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IEventSourceMapping	fromEventSourceMappingId(software.constructs.Construct scope, String id, String eventSourceMappingId) (experimental) Import an event source into this stack from its event source id.
String	getEventSourceMappingId() (experimental) The identifier for this EventSourceMapping.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

EventSourceMapping

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

EventSourceMapping

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

EventSourceMapping

@Stability(value=Experimental)
public EventSourceMapping(@NotNull
                                                         software.constructs.Construct scope,
                                                         @NotNull
                                                         String id,
                                                         @NotNull
                                                         EventSourceMappingProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromEventSourceMappingId

@Stability(value=Experimental)
 @NotNull
public static IEventSourceMapping fromEventSourceMappingId(@NotNull
                                                                                                    software.constructs.Construct scope,
                                                                                                    @NotNull
                                                                                                    String id,
                                                                                                    @NotNull
                                                                                                    String eventSourceMappingId)

(experimental) Import an event source into this stack from its event source id.

Parameters:

scope - This parameter is required.

id - This parameter is required.

eventSourceMappingId - This parameter is required.

getEventSourceMappingId

@Stability(value=Experimental)
 @NotNull
public String getEventSourceMappingId()

(experimental) The identifier for this EventSourceMapping.

Specified by:

getEventSourceMappingId in interface IEventSourceMapping