software.amazon.awscdk.services.lambda.eventsources

Interface KafkaEventSourceProps

All Superinterfaces:

BaseStreamEventSourceProps, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ManagedKafkaEventSourceProps, SelfManagedKafkaEventSourceProps

All Known Implementing Classes:

KafkaEventSourceProps.Jsii$Proxy, ManagedKafkaEventSourceProps.Jsii$Proxy, SelfManagedKafkaEventSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.509Z")
 @Stability(value=Stable)
public interface KafkaEventSourceProps
extends software.amazon.jsii.JsiiSerializable, BaseStreamEventSourceProps

Properties for a Kafka event source.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.services.lambda.eventsources.*;
 import software.amazon.awscdk.services.secretsmanager.*;
 Secret secret;
 KafkaEventSourceProps kafkaEventSourceProps = KafkaEventSourceProps.builder()
         .startingPosition(StartingPosition.TRIM_HORIZON)
         .topic("topic")
         // the properties below are optional
         .batchSize(123)
         .consumerGroupId("consumerGroupId")
         .enabled(false)
         .maxBatchingWindow(Duration.minutes(30))
         .secret(secret)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	KafkaEventSourceProps.Builder A builder for KafkaEventSourceProps
static class	KafkaEventSourceProps.Jsii$Proxy An implementation for KafkaEventSourceProps

Method Summary

Modifier and Type	Method and Description
static KafkaEventSourceProps.Builder	builder()
default String	getConsumerGroupId() The identifier for the Kafka consumer group to join.
default ISecret	getSecret() 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.
String	getTopic() The Kafka topic to subscribe to.

Methods inherited from interface software.amazon.awscdk.services.lambda.eventsources.BaseStreamEventSourceProps

getBatchSize, getEnabled, getMaxBatchingWindow, getStartingPosition

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTopic

@Stability(value=Stable)
 @NotNull
String getTopic()

The Kafka topic to subscribe to.

getConsumerGroupId

@Stability(value=Stable)
 @Nullable
default String getConsumerGroupId()

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 Also:

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

getSecret

@Stability(value=Stable)
 @Nullable
default ISecret getSecret()

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

builder

@Stability(value=Stable)
static KafkaEventSourceProps.Builder builder()

Specified by:

builder in interface BaseStreamEventSourceProps

Returns:

a KafkaEventSourceProps.Builder of KafkaEventSourceProps