# KinesisConsumerEventSource

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

Extends: [StreamEventSource](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda_event_sources.StreamEventSource.html) › KinesisConsumerEventSource
Implements: [IEventSource](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.IEventSource.html)

- Source: [`aws-lambda-event-sources/lib/kinesis.ts`](https://github.com/aws/aws-cdk/blob/v2.278.0/packages/aws-cdk-lib/aws-lambda-event-sources/lib/kinesis.ts#L101)
- Type last changed: v2.180.0 · 21 Feb 2025

## Example

TypeScript:

```ts
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,
}));
```

Python:

```python
import aws_cdk.aws_kinesis as kinesis
from aws_cdk.aws_lambda_event_sources import KinesisConsumerEventSource

# my_function: lambda.Function

stream = kinesis.Stream(self, "MyStream")
stream_consumer = kinesis.StreamConsumer(self, "MyStreamConsumer",
    stream=stream,
    stream_consumer_name="MyStreamConsumer"
)
my_function.add_event_source(KinesisConsumerEventSource(stream_consumer,
    batch_size=100,  # default
    starting_position=lambda_.StartingPosition.TRIM_HORIZON
))
```

Java:

```java
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());
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.Kinesis;
using Amazon.CDK.AWS.Lambda.EventSources;

Function myFunction;

var stream = new Stream(this, "MyStream");
var streamConsumer = new StreamConsumer(this, "MyStreamConsumer", new StreamConsumerProps {
    Stream = stream,
    StreamConsumerName = "MyStreamConsumer"
});
myFunction.AddEventSource(new KinesisConsumerEventSource(streamConsumer, new KinesisEventSourceProps {
    BatchSize = 100,  // default
    StartingPosition = StartingPosition.TRIM_HORIZON
}));
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var myFunction Function

stream := kinesis.NewStream(this, jsii.String("MyStream"))
streamConsumer := kinesis.NewStreamConsumer(this, jsii.String("MyStreamConsumer"), &StreamConsumerProps{
	Stream: Stream,
	StreamConsumerName: jsii.String("MyStreamConsumer"),
})
myFunction.AddEventSource(awscdk.NewKinesisConsumerEventSource(streamConsumer, &KinesisEventSourceProps{
	BatchSize: jsii.Number(100),
	 // default
	StartingPosition: lambda.StartingPosition_TRIM_HORIZON,
}))
```

## Initializer

TypeScript:

```ts
new KinesisConsumerEventSource(streamConsumer: IStreamConsumer, props: KinesisEventSourceProps)
```

Python:

```python
KinesisConsumerEventSource(stream_consumer: IStreamConsumer, props: KinesisEventSourceProps)
```

Java:

```java
new KinesisConsumerEventSource(IStreamConsumer streamConsumer, KinesisEventSourceProps props)
```

C# / .NET:

```csharp
new KinesisConsumerEventSource(IStreamConsumer streamConsumer, KinesisEventSourceProps props)
```

Golang:

```go
NewKinesisConsumerEventSource(StreamConsumer IStreamConsumer, Props KinesisEventSourceProps)
```

## Properties

- `eventSourceMappingArn`: string — The ARN for this EventSourceMapping.

- `eventSourceMappingId`: string — The identifier for this EventSourceMapping.

- `streamConsumer`: [IStreamConsumer](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.IStreamConsumer.html)

## Methods

- `bind(target: IFunction): void` — Called by `lambda.addEventSource` to allow the event source to bind to this function.
