Package software.amazon.awscdk.services.lambda.eventsources

Class DynamoEventSource

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.lambda.eventsources.StreamEventSource

software.amazon.awscdk.services.lambda.eventsources.DynamoEventSource

All Implemented Interfaces:

IEventSource, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:12.856Z")
@Stability(Stable)
public class DynamoEventSource
extends StreamEventSource

Use an Amazon DynamoDB stream as an event source for AWS Lambda.

Example:

 import software.amazon.awscdk.services.lambda.eventsources.*;
 import software.amazon.awscdk.services.dynamodb.*;
 Function fn;
 Table table = Table.Builder.create(this, "Table")
         .partitionKey(Attribute.builder()
                 .name("id")
                 .type(AttributeType.STRING)
                 .build())
         .stream(StreamViewType.NEW_IMAGE)
         .build();
 fn.addEventSource(DynamoEventSource.Builder.create(table)
         .startingPosition(StartingPosition.LATEST)
         .metricsConfig(MetricsConfig.builder()
                 .metrics(List.of(MetricType.EVENT_COUNT))
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

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

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.IEventSource

IEventSource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
	DynamoEventSource(ITable table, DynamoEventSourceProps props)
protected	DynamoEventSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DynamoEventSource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	bind(IFunction target)	Called by lambda.addEventSource to allow the event source to bind to this function.
String	getEventSourceMappingArn()	The ARN for this EventSourceMapping.
String	getEventSourceMappingId()	The identifier for this EventSourceMapping.

Methods inherited from class software.amazon.awscdk.services.lambda.eventsources.StreamEventSource

enrichMappingOptions, getProps

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

DynamoEventSource

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

DynamoEventSource

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

DynamoEventSource

@Stability(Stable)
public DynamoEventSource(@NotNull
 ITable table,
 @NotNull
 DynamoEventSourceProps props)

Parameters:

table - This parameter is required.

props - This parameter is required.

Method Details

bind

@Stability(Stable)
public void bind(@NotNull
 IFunction target)

Called by lambda.addEventSource to allow the event source to bind to this function.

Specified by:

bind in interface IEventSource

Specified by:

bind in class StreamEventSource

Parameters:

target - This parameter is required.

getEventSourceMappingArn

@Stability(Stable)
@NotNull
public String getEventSourceMappingArn()

The ARN for this EventSourceMapping.

getEventSourceMappingId

@Stability(Stable)
@NotNull
public String getEventSourceMappingId()

The identifier for this EventSourceMapping.