class KinesisConsumerEventSource

Language	Type name
.NET	Amazon.CDK.AWS.Lambda.EventSources.KinesisConsumerEventSource
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslambdaeventsources#KinesisConsumerEventSource
Java	software.amazon.awscdk.services.lambda.eventsources.KinesisConsumerEventSource
Python	aws_cdk.aws_lambda_event_sources.KinesisConsumerEventSource
TypeScript (source)	aws-cdk-lib » aws_lambda_event_sources » KinesisConsumerEventSource

Implements IEventSource

Extends StreamEventSource

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

Example

import * as kinesis from 'aws-cdk-lib/aws-kinesis';
import { KinesisConsumerEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';

const stream = new kinesis.Stream(this, 'MyStream');
const streamConsumer = new kinesis.StreamConsumer(this, 'MyStreamConsumer', {
  stream,
  streamConsumerName: 'MyStreamConsumer',
});

declare const myFunction: lambda.Function;
myFunction.addEventSource(new KinesisConsumerEventSource(streamConsumer, {
  batchSize: 100, // default
  startingPosition: lambda.StartingPosition.TRIM_HORIZON,
}));

Initializer

new KinesisConsumerEventSource(streamConsumer: IStreamConsumer, props: KinesisEventSourceProps)

Parameters

• streamConsumer IStreamConsumer
• props KinesisEventSourceProps

Properties

Name	Type	Description
eventSourceMappingArn	string	The ARN for this EventSourceMapping.
eventSourceMappingId	string	The identifier for this EventSourceMapping.
streamConsumer	IStreamConsumer

---

eventSourceMappingArn

Type: string

The ARN for this EventSourceMapping.

---

eventSourceMappingId

Type: string

The identifier for this EventSourceMapping.

---

streamConsumer

Type: IStreamConsumer

Methods

Name	Description
bind(target)	Called by lambda.addEventSource to allow the event source to bind to this function.

---

bind(target)

public bind(target: IFunction): void

Parameters

• target IFunction

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