2.232.2

interface SelfManagedKafkaEventSourceProps

LanguageType name
.NETAmazon.CDK.AWS.Lambda.EventSources.SelfManagedKafkaEventSourceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslambdaeventsources#SelfManagedKafkaEventSourceProps
Javasoftware.amazon.awscdk.services.lambda.eventsources.SelfManagedKafkaEventSourceProps
Pythonaws_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 { SelfManagedKafkaEventSource, AuthenticationMethod } from 'aws-cdk-lib/aws-lambda-event-sources';
import { StartingPosition, Function } from 'aws-cdk-lib/aws-lambda';
import { ISecret } from 'aws-cdk-lib/aws-secretsmanager';

// With provisioned pollers and poller group for cost optimization
declare const myFunction: Function;
declare const kafkaCredentials: ISecret;
myFunction.addEventSource(new SelfManagedKafkaEventSource({
  bootstrapServers: ['kafka-broker1.example.com:9092', 'kafka-broker2.example.com:9092'],
  topic: 'events-topic',
  secret: kafkaCredentials,
  startingPosition: StartingPosition.LATEST,
  authenticationMethod: AuthenticationMethod.SASL_SCRAM_512_AUTH,
  provisionedPollerConfig: {
    minimumPollers: 1,
    maximumPollers: 8,
    pollerGroupName: 'self-managed-kafka-group', // Group pollers to reduce costs
  },
}));

Properties

NameTypeDescription
bootstrapServersstring[]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.
startingPositionStartingPositionWhere to begin consuming the stream.
topicstringThe Kafka topic to subscribe to.
authenticationMethod?AuthenticationMethodThe authentication method for your Kafka cluster.
batchSize?numberThe largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
bisectBatchOnError?boolean* If the function returns an error, split the batch in two and retry.
consumerGroupId?stringThe identifier for the Kafka consumer group to join.
enabled?booleanIf the stream event source mapping should be enabled.
filterEncryption?IKeyAdd Customer managed KMS key to encrypt Filter Criteria.
filters?{ [string]: any }[]Add filter criteria to Event Source.
maxBatchingWindow?DurationThe maximum amount of time to gather records before invoking the function.
maxRecordAge?DurationThe maximum age of a record that Lambda sends to a function for processing.
onFailure?IEventSourceDlqAdd an on Failure Destination for this Kafka event.
provisionedPollerConfig?ProvisionedPollerConfigConfiguration for provisioned pollers that read from the event source.
reportBatchItemFailures?boolean* Allow functions to return partially successful responses for a batch of records.
retryAttempts?number* Maximum number of retry attempts.
rootCACertificate?ISecretThe 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.
schemaRegistryConfig?ISchemaRegistrySpecific configuration settings for a Kafka schema registry.
secret?ISecretThe 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?ISecurityGroupIf your Kafka brokers are only reachable via VPC, provide the security group here.
startingPositionTimestamp?numberThe time from which to start reading, in Unix time seconds.
vpc?IVpcIf your Kafka brokers are only reachable via VPC provide the VPC here.
vpcSubnets?SubnetSelectionIf 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

bisectBatchOnError?

Type: boolean (optional, default: false)

  • If the function returns an error, split the batch in two and retry.

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

maxRecordAge?

Type: Duration (optional, default: -1)

The maximum age of a record that Lambda sends to a function for processing.

The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records. Record are valid until it expires in the event source.

onFailure?

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

Add an on Failure Destination for this Kafka event.

Supported destinations:

  • {@link KafkaDlq } - Send failed records to a Kafka topic
  • SNS topics - Send failed records to an SNS topic
  • SQS queues - Send failed records to an SQS queue
  • S3 buckets - Send failed records to an S3 bucket

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.

reportBatchItemFailures?

Type: boolean (optional, default: false)

  • Allow functions to return partially successful responses for a batch of records.

retryAttempts?

Type: number (optional, default: -1 (infinite retries))

  • Maximum number of retry attempts.

Set to -1 for infinite retries (until the record expires in the event 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.

schemaRegistryConfig?

Type: ISchemaRegistry (optional, default: none)

Specific configuration settings for a Kafka schema registry.

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.

← PreviousNext →