View a markdown version of this page

AWS::Lambda::EventSourceMapping SelfManagedKafkaEventSourceConfig - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Lambda::EventSourceMapping SelfManagedKafkaEventSourceConfig

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

Properties

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.

Required: No

Type: String

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

Minimum: 1

Maximum: 200

Update requires: No interruption

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.

Required: No

Type: String

Allowed values: Stream | Queue

Update requires: No interruption

SchemaRegistryConfig

Specific configuration settings for a Kafka schema registry.

Required: No

Type: SchemaRegistryConfig

Update requires: No interruption