aws-cdk-lib.aws_lambda_event_sources.KinesisEventSource

class KinesisEventSource

LanguageType name
.NETAmazon.CDK.AWS.Lambda.EventSources.KinesisEventSource
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslambdaeventsources#KinesisEventSource
Javasoftware.amazon.awscdk.services.lambda.eventsources.KinesisEventSource
Pythonaws_cdk.aws_lambda_event_sources.KinesisEventSource
TypeScript (source)aws-cdk-lib » aws_lambda_event_sources » KinesisEventSource

Implements IEventSource

Extends StreamEventSource

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

Example

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

const stream = new kinesis.Stream(this, 'MyStream');

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

Initializer

new KinesisEventSource(stream: IStream, props: KinesisEventSourceProps)

Parameters

  • stream IStream
  • props KinesisEventSourceProps

Properties

NameTypeDescription
eventSourceMappingArnstringThe ARN for this EventSourceMapping.
eventSourceMappingIdstringThe identifier for this EventSourceMapping.
streamIStream

eventSourceMappingArn

Type: string

The ARN for this EventSourceMapping.


eventSourceMappingId

Type: string

The identifier for this EventSourceMapping.


stream

Type: IStream

Methods

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