software.amazon.awscdk.services.lambda.eventsources

Interface KafkaEventSourceProps

All Superinterfaces:

BaseStreamEventSourceProps

All Known Subinterfaces:

ManagedKafkaEventSourceProps, SelfManagedKafkaEventSourceProps

All Known Implementing Classes:

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

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:59.878Z")
public interface KafkaEventSourceProps
extends 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.services.lambda.*;
 import software.amazon.awscdk.services.lambda.eventsources.*;
 import software.amazon.awscdk.services.secretsmanager.*;
 import software.amazon.awscdk.core.*;
 Secret secret;
 KafkaEventSourceProps kafkaEventSourceProps = KafkaEventSourceProps.builder()
         .startingPosition(StartingPosition.TRIM_HORIZON)
         .topic("topic")
         // the properties below are optional
         .batchSize(123)
         .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 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.
java.lang.String	getTopic() The Kafka topic to subscribe to.

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

getBatchSize, getEnabled, getMaxBatchingWindow, getStartingPosition

Method Detail

getTopic

java.lang.String getTopic()

The Kafka topic to subscribe to.

getSecret

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

static KafkaEventSourceProps.Builder builder()

Specified by:

builder in interface BaseStreamEventSourceProps

Returns:

a KafkaEventSourceProps.Builder of KafkaEventSourceProps