interface KinesisEventSourceProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Lambda.EventSources.KinesisEventSourceProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awslambdaeventsources#KinesisEventSourceProps |
Java | software.amazon.awscdk.services.lambda.eventsources.KinesisEventSourceProps |
Python | aws_cdk.aws_lambda_event_sources.KinesisEventSourceProps |
TypeScript (source) | aws-cdk-lib » aws_lambda_event_sources » KinesisEventSourceProps |
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,
}));
Properties
Name | Type | Description |
---|---|---|
starting | Starting | Where to begin consuming the stream. |
batch | number | The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. |
bisect | boolean | If the function returns an error, split the batch in two and retry. |
enabled? | boolean | If the stream event source mapping should be enabled. |
filters? | { [string]: any }[] | Add filter criteria option. |
max | Duration | The maximum amount of time to gather records before invoking the function. |
max | Duration | The maximum age of a record that Lambda sends to a function for processing. |
on | IEvent | An Amazon SQS queue or Amazon SNS topic destination for discarded records. |
parallelization | number | The number of batches to process from each shard concurrently. |
report | boolean | Allow functions to return partially successful responses for a batch of records. |
retry | number | Maximum number of retry attempts Valid Range: * Minimum value of 0 * Maximum value of 10000. |
starting | number | The time from which to start reading, in Unix time seconds. |
tumbling | Duration | The size of the tumbling windows to group records sent to DynamoDB or Kinesis Valid Range: 0 - 15 minutes. |
startingPosition
Type:
Starting
Where to begin consuming the stream.
batchSize?
Type:
number
(optional, default: 100)
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
Your function receives an event with all the retrieved records.
Valid Range:
- Minimum value of 1
- Maximum value of:
- 1000 for
DynamoEventSource
- 10000 for
KinesisEventSource
,ManagedKafkaEventSource
andSelfManagedKafkaEventSource
- 1000 for
bisectBatchOnError?
Type:
boolean
(optional, default: false)
If the function returns an error, split the batch in two and retry.
enabled?
Type:
boolean
(optional, default: true)
If the stream event source mapping should be enabled.
filters?
Type:
{ [string]: any }[]
(optional, default: None)
Add filter criteria option.
maxBatchingWindow?
Type:
Duration
(optional, default: Duration.seconds(0) for Kinesis, DynamoDB, and SQS event sources, Duration.millis(500) for MSK, self-managed Kafka, and Amazon MQ.)
The maximum amount of time to gather records before invoking the function.
Maximum of Duration.minutes(5).
maxRecordAge?
Type:
Duration
(optional, default: the retention period configured on the stream)
The maximum age of a record that Lambda sends to a function for processing.
Valid Range:
- Minimum value of 60 seconds
- Maximum value of 7 days
onFailure?
Type:
IEvent
(optional, default: discarded records are ignored)
An Amazon SQS queue or Amazon SNS topic destination for discarded records.
parallelizationFactor?
Type:
number
(optional, default: 1)
The number of batches to process from each shard concurrently.
Valid Range:
- Minimum value of 1
- Maximum value of 10
reportBatchItemFailures?
Type:
boolean
(optional, default: false)
Allow functions to return partially successful responses for a batch of records.
See also: https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting
retryAttempts?
Type:
number
(optional, default: retry until the record expires)
Maximum number of retry attempts Valid Range: * Minimum value of 0 * Maximum value of 10000.
startingPositionTimestamp?
Type:
number
(optional, default: no timestamp)
The time from which to start reading, in Unix time seconds.
tumblingWindow?
Type:
Duration
(optional, default: None)
The size of the tumbling windows to group records sent to DynamoDB or Kinesis Valid Range: 0 - 15 minutes.