software.amazon.awscdk.services.lambda

Class EventSourceMapping

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.lambda.EventSourceMapping

All Implemented Interfaces:

IConstruct, IDependable, IResource, IEventSourceMapping

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:39.516Z")
public class EventSourceMapping
extends Resource
implements IEventSourceMapping

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.core.*;
 IEventSourceDlq eventSourceDlq;
 Function function_;
 SourceAccessConfigurationType sourceAccessConfigurationType;
 EventSourceMapping eventSourceMapping = EventSourceMapping.Builder.create(this, "MyEventSourceMapping")
         .target(function_)
         // the properties below are optional
         .batchSize(123)
         .bisectBatchOnError(false)
         .enabled(false)
         .eventSourceArn("eventSourceArn")
         .kafkaBootstrapServers(List.of("kafkaBootstrapServers"))
         .kafkaTopic("kafkaTopic")
         .maxBatchingWindow(Duration.minutes(30))
         .maxRecordAge(Duration.minutes(30))
         .onFailure(eventSourceDlq)
         .parallelizationFactor(123)
         .reportBatchItemFailures(false)
         .retryAttempts(123)
         .sourceAccessConfigurations(List.of(SourceAccessConfiguration.builder()
                 .type(sourceAccessConfigurationType)
                 .uri("uri")
                 .build()))
         .startingPosition(StartingPosition.TRIM_HORIZON)
         .tumblingWindow(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

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

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
protected	EventSourceMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	EventSourceMapping(software.amazon.jsii.JsiiObjectRef objRef)
	EventSourceMapping(software.constructs.Construct scope, java.lang.String id, EventSourceMappingProps props)

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

EventSourceMapping

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

EventSourceMapping

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

EventSourceMapping

public EventSourceMapping(software.constructs.Construct scope,
                          java.lang.String id,
                          EventSourceMappingProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromEventSourceMappingId

public static IEventSourceMapping fromEventSourceMappingId(software.constructs.Construct scope,
                                                           java.lang.String id,
                                                           java.lang.String eventSourceMappingId)

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

public java.lang.String getEventSourceMappingId()

The identifier for this EventSourceMapping.

Specified by:

getEventSourceMappingId in interface IEventSourceMapping