interface SelfManagedKafkaEventSourceProps

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

Properties for a self managed Kafka cluster event source.

If your Kafka cluster is only reachable via VPC make sure to configure it.

Example

import { Secret } from 'aws-cdk-lib/aws-secretsmanager';
import { SelfManagedKafkaEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';

// The list of Kafka brokers
const bootstrapServers = ['kafka-broker:9092'];

// The Kafka topic you want to subscribe to
const topic = 'some-cool-topic';

// The secret that allows access to your self hosted Kafka cluster
declare const secret: Secret;

// (Optional) The consumer group id to use when connecting to the Kafka broker. If omitted the UUID of the event source mapping will be used.
const consumerGroupId = "my-consumer-group-id";

declare const myFunction: lambda.Function;
myFunction.addEventSource(new SelfManagedKafkaEventSource({
  bootstrapServers: bootstrapServers,
  topic: topic,
  consumerGroupId: consumerGroupId,
  secret: secret,
  batchSize: 100, // default
  startingPosition: lambda.StartingPosition.TRIM_HORIZON,
}));

Properties

Name	Type	Description
bootstrapServers	string[]	The list of host and port pairs that are the addresses of the Kafka brokers in a "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself.
startingPosition	StartingPosition	Where to begin consuming the stream.
topic	string	The Kafka topic to subscribe to.
authenticationMethod?	AuthenticationMethod	The authentication method for your Kafka cluster.
batchSize?	number	The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
consumerGroupId?	string	The identifier for the Kafka consumer group to join.
enabled?	boolean	If the stream event source mapping should be enabled.
filterEncryption?	IKey	Add Customer managed KMS key to encrypt Filter Criteria.
filters?	{ [string]: any }[]	Add filter criteria to Event Source.
maxBatchingWindow?	Duration	The maximum amount of time to gather records before invoking the function.
onFailure?	IEventSourceDlq	Add an on Failure Destination for this Kafka event.
provisionedPollerConfig?	ProvisionedPollerConfig	Configuration for provisioned pollers that read from the event source.
rootCACertificate?	ISecret	The secret with the root CA certificate used by your Kafka brokers for TLS encryption This field is required if your Kafka brokers use certificates signed by a private CA.
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.
securityGroup?	ISecurityGroup	If your Kafka brokers are only reachable via VPC, provide the security group here.
startingPositionTimestamp?	number	The time from which to start reading, in Unix time seconds.
vpc?	IVpc	If your Kafka brokers are only reachable via VPC provide the VPC here.
vpcSubnets?	SubnetSelection	If your Kafka brokers are only reachable via VPC, provide the subnets selection here.

---

bootstrapServers

Type: string[]

The list of host and port pairs that are the addresses of the Kafka brokers in a "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself.

They are in the format abc.xyz.com:xxxx.

---

startingPosition

Type: StartingPosition

Where to begin consuming the stream.

---

topic

Type: string

The Kafka topic to subscribe to.

---

authenticationMethod?

Type: AuthenticationMethod (optional, default: AuthenticationMethod.SASL_SCRAM_512_AUTH)

The authentication method for your Kafka cluster.

---

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 and SelfManagedKafkaEventSource

---

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

---

filterEncryption?

Type: IKey (optional, default: none)

Add Customer managed KMS key to encrypt Filter Criteria.

See also: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk

---

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

See also: https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-batching

---

onFailure?

Type: IEventSourceDlq (optional, default: discarded records are ignored)

Add an on Failure Destination for this Kafka event.

SNS/SQS/S3 are supported

---

provisionedPollerConfig?

Type: ProvisionedPollerConfig (optional, default: no provisioned pollers)

Configuration for provisioned pollers that read from the event source.

When specified, allows control over the minimum and maximum number of pollers that can be provisioned to process events from the source.

---

rootCACertificate?

Type: ISecret (optional, default: none)

The secret with the root CA certificate used by your Kafka brokers for TLS encryption This field is required if your Kafka brokers use certificates signed by a private CA.

---

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.

---

securityGroup?

Type: ISecurityGroup (optional, default: none, required if setting vpc)

If your Kafka brokers are only reachable via VPC, provide the security group here.

---

startingPositionTimestamp?

Type: number (optional, default: no timestamp)

The time from which to start reading, in Unix time seconds.

---

vpc?

Type: IVpc (optional, default: none)

If your Kafka brokers are only reachable via VPC provide the VPC here.

---

vpcSubnets?

Type: SubnetSelection (optional, default: none, required if setting vpc)

If your Kafka brokers are only reachable via VPC, provide the subnets selection here.