software.amazon.awscdk.services.lambda.eventsources

Interface KafkaEventSourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, StreamEventSourceProps

All Known Subinterfaces:

ManagedKafkaEventSourceProps, SelfManagedKafkaEventSourceProps

All Known Implementing Classes:

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

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:11.486Z")
 @Stability(value=Experimental)
public interface KafkaEventSourceProps
extends software.amazon.jsii.JsiiSerializable, StreamEventSourceProps

(experimental) 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.core.*;
 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.services.lambda.eventsources.*;
 import software.amazon.awscdk.services.secretsmanager.*;
 Duration duration;
 IEventSourceDlq eventSourceDlq;
 Secret secret;
 KafkaEventSourceProps kafkaEventSourceProps = KafkaEventSourceProps.builder()
         .startingPosition(StartingPosition.TRIM_HORIZON)
         .topic("topic")
         // the properties below are optional
         .batchSize(123)
         .bisectBatchOnError(false)
         .enabled(false)
         .maxBatchingWindow(duration)
         .maxRecordAge(duration)
         .onFailure(eventSourceDlq)
         .parallelizationFactor(123)
         .reportBatchItemFailures(false)
         .retryAttempts(123)
         .secret(secret)
         .tumblingWindow(duration)
         .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() (experimental) 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() (experimental) The Kafka topic to subscribe to.

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

getBatchSize, getBisectBatchOnError, getEnabled, getMaxBatchingWindow, getMaxRecordAge, getOnFailure, getParallelizationFactor, getReportBatchItemFailures, getRetryAttempts, getStartingPosition, getTumblingWindow

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTopic

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

(experimental) The Kafka topic to subscribe to.

getSecret

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

(experimental) 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=Experimental)
static KafkaEventSourceProps.Builder builder()

Specified by:

builder in interface StreamEventSourceProps

Returns:

a KafkaEventSourceProps.Builder of KafkaEventSourceProps