interface KafkaEventSourceProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Lambda.EventSources.KafkaEventSourceProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awslambdaeventsources#KafkaEventSourceProps |
Java | software.amazon.awscdk.services.lambda.eventsources.KafkaEventSourceProps |
Python | aws_cdk.aws_lambda_event_sources.KafkaEventSourceProps |
TypeScript (source) | aws-cdk-lib » aws_lambda_event_sources » KafkaEventSourceProps |
Properties for a Kafka event source.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_lambda as lambda } from 'aws-cdk-lib';
import { aws_lambda_event_sources as lambda_event_sources } from 'aws-cdk-lib';
import { aws_secretsmanager as secretsmanager } from 'aws-cdk-lib';
declare const eventSourceDlq: lambda.IEventSourceDlq;
declare const filters: any;
declare const secret: secretsmanager.Secret;
const kafkaEventSourceProps: lambda_event_sources.KafkaEventSourceProps = {
startingPosition: lambda.StartingPosition.TRIM_HORIZON,
topic: 'topic',
// the properties below are optional
batchSize: 123,
consumerGroupId: 'consumerGroupId',
enabled: false,
filters: [{
filtersKey: filters,
}],
maxBatchingWindow: cdk.Duration.minutes(30),
onFailure: eventSourceDlq,
secret: secret,
};
Properties
Name | Type | Description |
---|---|---|
starting | Starting | Where to begin consuming the stream. |
topic | string | The Kafka topic to subscribe to. |
batch | number | The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. |
consumer | string | The identifier for the Kafka consumer group to join. |
enabled? | boolean | If the stream event source mapping should be enabled. |
filters? | { [string]: any }[] | Add filter criteria to Event Source. |
max | Duration | The maximum amount of time to gather records before invoking the function. |
on | IEvent | Add an on Failure Destination for this Kafka event. |
secret? | ISecret | The secret with the Kafka credentials, see https://docs.aws.amazon.com/msk/latest/developerguide/msk-password.html for details This field is required if your Kafka brokers are accessed over the Internet. |
startingPosition
Type:
Starting
Where to begin consuming the stream.
topic
Type:
string
The Kafka topic to subscribe to.
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
consumerGroupId?
Type:
string
(optional, default: none)
The identifier for the Kafka consumer group to join.
The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. The value must have a lenght between 1 and 200 and full the pattern '[a-zA-Z0-9-/:_+=.@-]'.
See also: https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id
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 to Event Source.
See also: https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html
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).
onFailure?
Type:
IEvent
(optional, default: discarded records are ignored)
Add an on Failure Destination for this Kafka event.
SNS/SQS/S3 are supported
secret?
Type:
ISecret
(optional, default: none)
The secret with the Kafka credentials, see https://docs.aws.amazon.com/msk/latest/developerguide/msk-password.html for details This field is required if your Kafka brokers are accessed over the Internet.