Skip to content
v2.278.0

KafkaConsumptionMode Class ​

How Lambda reads records from a Kafka topic.

Example ​

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

declare const myFunction: lambda.Function;
declare const secret: Secret;

myFunction.addEventSource(new SelfManagedKafkaEventSource({
  bootstrapServers: ['kafka-broker-1:9092', 'kafka-broker-2:9092'],
  topic: 'orders',
  secret,
  consumerGroupId: 'orders-queue',
  consumptionMode: lambda.KafkaConsumptionMode.QUEUE,
}));
python
from aws_cdk.aws_secretsmanager import Secret
from aws_cdk.aws_lambda_event_sources import SelfManagedKafkaEventSource

# my_function: lambda.Function
# secret: Secret


my_function.add_event_source(SelfManagedKafkaEventSource(
    bootstrap_servers=["kafka-broker-1:9092", "kafka-broker-2:9092"],
    topic="orders",
    secret=secret,
    consumer_group_id="orders-queue",
    consumption_mode=lambda_.KafkaConsumptionMode.QUEUE
))
java
import software.amazon.awscdk.services.secretsmanager.Secret;
import software.amazon.awscdk.services.lambda.eventsources.SelfManagedKafkaEventSource;

Function myFunction;
Secret secret;


myFunction.addEventSource(SelfManagedKafkaEventSource.Builder.create()
        .bootstrapServers(List.of("kafka-broker-1:9092", "kafka-broker-2:9092"))
        .topic("orders")
        .secret(secret)
        .consumerGroupId("orders-queue")
        .consumptionMode(KafkaConsumptionMode.QUEUE)
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.SecretsManager;
using Amazon.CDK.AWS.Lambda.EventSources;

Function myFunction;
Secret secret;


myFunction.AddEventSource(new SelfManagedKafkaEventSource(new SelfManagedKafkaEventSourceProps {
    BootstrapServers = new [] { "kafka-broker-1:9092", "kafka-broker-2:9092" },
    Topic = "orders",
    Secret = secret,
    ConsumerGroupId = "orders-queue",
    ConsumptionMode = KafkaConsumptionMode.QUEUE
}));
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var myFunction Function
var secret Secret


myFunction.AddEventSource(awscdk.NewSelfManagedKafkaEventSource(&SelfManagedKafkaEventSourceProps{
	BootstrapServers: []*string{
		jsii.String("kafka-broker-1:9092"),
		jsii.String("kafka-broker-2:9092"),
	},
	Topic: jsii.String("orders"),
	Secret: Secret,
	ConsumerGroupId: jsii.String("orders-queue"),
	ConsumptionMode: lambda.KafkaConsumptionMode_QUEUE(),
}))

Properties ​

modestringmodestrmodeStringModestringMode*string #
The value of the `ConsumptionMode` property.
Read the topic as a Kafka share group.

Records in a partition can be processed in parallel, without ordering. Requires Kafka 4.2.0 or later.

Read the topic as a Kafka consumer group.

Records in a partition are processed in order.

Methods ​

of(mode: string): KafkaConsumptionMode // chainable@staticmethod def of(mode: str) -> KafkaConsumptionModepublic static KafkaConsumptionMode of(String mode)public static KafkaConsumptionMode Of(string mode)func Of(Mode *string) KafkaConsumptionMode static #
A consumption mode that this library doesn't model.
1 parameter

Parameters

  • modemodemodemodeMode — The value of the ConsumptionMode property.