KafkaEventSourceProps

class aws_cdk.aws_lambda_event_sources.KafkaEventSourceProps(*, starting_position, batch_size=None, enabled=None, max_batching_window=None, topic, consumer_group_id=None, filters=None, on_failure=None, secret=None)

Bases: BaseStreamEventSourceProps

Properties for a Kafka event source.

Parameters:

starting_position (StartingPosition) – Where to begin consuming the stream.
batch_size (Union[int, float, None]) – 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 Default: 100
enabled (Optional[bool]) – If the stream event source mapping should be enabled. Default: true
max_batching_window (Optional[Duration]) – The maximum amount of time to gather records before invoking the function. Maximum of Duration.minutes(5). Default: - Duration.seconds(0) for Kinesis, DynamoDB, and SQS event sources, Duration.millis(500) for MSK, self-managed Kafka, and Amazon MQ.
topic (str) – The Kafka topic to subscribe to.
consumer_group_id (Optional[str]) – 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-/:_+=.@-]’. Default: - none
filters (Optional[Sequence[Mapping[str, Any]]]) – Add filter criteria to Event Source. Default: - none
on_failure (Optional[IEventSourceDlq]) – Add an on Failure Destination for this Kafka event. SNS/SQS/S3 are supported Default: - discarded records are ignored
secret (Optional[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. Default: none

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_lambda as lambda_
from aws_cdk import aws_lambda_event_sources as lambda_event_sources
from aws_cdk import aws_secretsmanager as secretsmanager

# event_source_dlq: lambda.IEventSourceDlq
# filters: Any
# secret: secretsmanager.Secret

kafka_event_source_props = lambda_event_sources.KafkaEventSourceProps(
    starting_position=lambda_.StartingPosition.TRIM_HORIZON,
    topic="topic",

    # the properties below are optional
    batch_size=123,
    consumer_group_id="consumerGroupId",
    enabled=False,
    filters=[{
        "filters_key": filters
    }],
    max_batching_window=cdk.Duration.minutes(30),
    on_failure=event_source_dlq,
    secret=secret
)

Attributes

batch_size

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

Default:: 100

consumer_group_id

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-/:_+=.@-]’.

Default:

none

See:

https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id

enabled

If the stream event source mapping should be enabled.

Default:: true

filters

Add filter criteria to Event Source.

Default:

none

See:

https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html

max_batching_window

The maximum amount of time to gather records before invoking the function.

Maximum of Duration.minutes(5).

Default:

Duration.seconds(0) for Kinesis, DynamoDB, and SQS event sources, Duration.millis(500) for MSK, self-managed Kafka, and Amazon MQ.

See:

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

on_failure

Add an on Failure Destination for this Kafka event.

SNS/SQS/S3 are supported

Default:

discarded records are ignored

secret

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

Default:: none
Type:: The secret with the Kafka credentials, see https

starting_position: Where to begin consuming the stream.

topic: The Kafka topic to subscribe to.