SelfManagedKafkaEventSourceConfig - AWS Lambda
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

SelfManagedKafkaEventSourceConfig

Specific configuration settings for a self-managed Apache Kafka event source.

Contents

ConsumerGroupId

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. For more information, see Customizable consumer group ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [a-zA-Z0-9-\/*:_+=.@-]*

Required: No

ConsumptionMode

The mode that Lambda uses to consume records from your self-managed Apache Kafka topic. Valid values are the following:

  • Stream (default) – Lambda consumes records using a Kafka consumer group and preserves the order of records within each partition.

  • Queue – Lambda consumes records using a Kafka share group. Multiple consumers can process records from the same partition concurrently, so Lambda doesn't preserve per-partition order. To use Queue mode, your cluster must run Apache Kafka version 4.2 or later with share groups enabled.

If you omit this parameter, Lambda uses Stream.

You cannot change ConsumptionMode after you create the event source mapping. To use a different consumption mode, create a new event source mapping.

When ConsumptionMode is Queue, the StartingPosition, StartingPositionTimestamp, and MaximumBatchingWindowInSeconds parameters are not supported.

Type: String

Valid Values: Stream | Queue

Required: No

SchemaRegistryConfig

Specific configuration settings for a Kafka schema registry.

Type: KafkaSchemaRegistryConfig object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: