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

Class KinesisEventSource

java.lang.Object

software.amazon.jsii.JsiiObject

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

software.amazon.awscdk.services.lambda.eventsources.KinesisEventSource

All Implemented Interfaces:

IEventSource, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-15T01:32:50.472Z")
@Stability(Stable)
public class KinesisEventSource
extends StreamEventSource

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

Example:

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

Nested Class Summary

Nested Classes

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

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
	KinesisEventSource(IStream stream, KinesisEventSourceProps props)
protected	KinesisEventSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	KinesisEventSource(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.
IStream	getStream()

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

KinesisEventSource

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

KinesisEventSource

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

KinesisEventSource

@Stability(Stable)
public KinesisEventSource(@NotNull
 IStream stream,
 @NotNull
 KinesisEventSourceProps props)

Parameters:

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

getStream

@Stability(Stable)
@NotNull
public IStream getStream()