software.amazon.awscdk.services.lambda.eventsources

Interface SelfManagedKafkaEventSourceProps

All Superinterfaces:

BaseStreamEventSourceProps, KafkaEventSourceProps

All Known Implementing Classes:

SelfManagedKafkaEventSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:49.252Z")
public interface SelfManagedKafkaEventSourceProps
extends KafkaEventSourceProps

Properties for a self managed Kafka cluster event source.

If your Kafka cluster is only reachable via VPC make sure to configure it.

Example:

 import software.amazon.awscdk.services.secretsmanager.Secret;
 import software.amazon.awscdk.services.lambda.eventsources.SelfManagedKafkaEventSource;
 // The secret that allows access to your self hosted Kafka cluster
 Secret secret;
 Function myFunction;
 // The list of Kafka brokers
 String[] bootstrapServers = List.of("kafka-broker:9092");
 // The Kafka topic you want to subscribe to
 String topic = "some-cool-topic";
 myFunction.addEventSource(SelfManagedKafkaEventSource.Builder.create()
         .bootstrapServers(bootstrapServers)
         .topic(topic)
         .secret(secret)
         .batchSize(100) // default
         .startingPosition(StartingPosition.TRIM_HORIZON)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SelfManagedKafkaEventSourceProps.Builder	builder()
default AuthenticationMethod	getAuthenticationMethod() The authentication method for your Kafka cluster.
java.util.List<java.lang.String>	getBootstrapServers() The list of host and port pairs that are the addresses of the Kafka brokers in a "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself.
default ISecurityGroup	getSecurityGroup() If your Kafka brokers are only reachable via VPC, provide the security group here.
default IVpc	getVpc() If your Kafka brokers are only reachable via VPC provide the VPC here.
default SubnetSelection	getVpcSubnets() If your Kafka brokers are only reachable via VPC, provide the subnets selection here.

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

getSecret, getTopic

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

getBatchSize, getEnabled, getMaxBatchingWindow, getStartingPosition

Method Detail

getBootstrapServers

java.util.List<java.lang.String> getBootstrapServers()

The list of host and port pairs that are the addresses of the Kafka brokers in a "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself.

They are in the format abc.xyz.com:xxxx.

getAuthenticationMethod

default AuthenticationMethod getAuthenticationMethod()

The authentication method for your Kafka cluster.

Default: AuthenticationMethod.SASL_SCRAM_512_AUTH

getSecurityGroup

default ISecurityGroup getSecurityGroup()

If your Kafka brokers are only reachable via VPC, provide the security group here.

Default: - none, required if setting vpc

getVpc

default IVpc getVpc()

If your Kafka brokers are only reachable via VPC provide the VPC here.

Default: none

getVpcSubnets

default SubnetSelection getVpcSubnets()

If your Kafka brokers are only reachable via VPC, provide the subnets selection here.

Default: - none, required if setting vpc

builder

static SelfManagedKafkaEventSourceProps.Builder builder()

Specified by:

builder in interface BaseStreamEventSourceProps

Specified by:

builder in interface KafkaEventSourceProps

Returns:

a SelfManagedKafkaEventSourceProps.Builder of SelfManagedKafkaEventSourceProps