aws-cdk-lib.aws_lambda_event_sources.ManagedKafkaEventSourceProps

interface ManagedKafkaEventSourceProps

LanguageType name
.NETAmazon.CDK.AWS.Lambda.EventSources.ManagedKafkaEventSourceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslambdaeventsources#ManagedKafkaEventSourceProps
Javasoftware.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSourceProps
Pythonaws_cdk.aws_lambda_event_sources.ManagedKafkaEventSourceProps
TypeScript (source)aws-cdk-lib » aws_lambda_event_sources » ManagedKafkaEventSourceProps

Properties for a MSK event source.

Example

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

// Your MSK cluster arn
const clusterArn = 'arn:aws:kafka:us-east-1:0123456789019:cluster/SalesCluster/abcd1234-abcd-cafe-abab-9876543210ab-4';

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

// The secret that allows access to your MSK cluster
// You still have to make sure that it is associated with your cluster as described in the documentation
const secret = new Secret(this, 'Secret', { secretName: 'AmazonMSK_KafkaSecret' });

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

Properties

NameTypeDescription
clusterArnstringAn MSK cluster construct.
startingPositionStartingPositionWhere to begin consuming the stream.
topicstringThe Kafka topic to subscribe to.
batchSize?numberThe largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
consumerGroupId?stringThe identifier for the Kafka consumer group to join.
enabled?booleanIf the stream event source mapping should be enabled.
maxBatchingWindow?DurationThe maximum amount of time to gather records before invoking the function.
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.

clusterArn

Type: string

An MSK cluster construct.


startingPosition

Type: StartingPosition

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


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


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.