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

Class KinesisConsumerEventSource

java.lang.Object

software.amazon.jsii.JsiiObject

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

software.amazon.awscdk.services.lambda.eventsources.KinesisConsumerEventSource

All Implemented Interfaces:

IEventSource, software.amazon.jsii.JsiiSerializable

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

Use an Amazon Kinesis stream consumer as an event source for AWS Lambda.

Example:

 import software.amazon.awscdk.services.kinesis.*;
 import software.amazon.awscdk.services.lambda.eventsources.KinesisConsumerEventSource;
 Function myFunction;
 Stream stream = new Stream(this, "MyStream");
 StreamConsumer streamConsumer = StreamConsumer.Builder.create(this, "MyStreamConsumer")
         .stream(stream)
         .streamConsumerName("MyStreamConsumer")
         .build();
 myFunction.addEventSource(KinesisConsumerEventSource.Builder.create(streamConsumer)
         .batchSize(100) // default
         .startingPosition(StartingPosition.TRIM_HORIZON)
         .build());
 

Nested Class Summary

Nested Classes

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

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
	KinesisConsumerEventSource(IStreamConsumer streamConsumer, KinesisEventSourceProps props)
protected	KinesisConsumerEventSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	KinesisConsumerEventSource(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.
IStreamConsumer	getStreamConsumer()

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

KinesisConsumerEventSource

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

KinesisConsumerEventSource

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

KinesisConsumerEventSource

@Stability(Stable)
public KinesisConsumerEventSource(@NotNull
 IStreamConsumer streamConsumer,
 @NotNull
 KinesisEventSourceProps props)

Parameters:

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

getStreamConsumer

@Stability(Stable)
@NotNull
public IStreamConsumer getStreamConsumer()