software.amazon.awscdk.services.lambda.eventsources

Class ManagedKafkaEventSource.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSource.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ManagedKafkaEventSource>

Enclosing class:

ManagedKafkaEventSource

@Stability(value=Stable)
public static final class ManagedKafkaEventSource.Builder
extends Object
implements software.amazon.jsii.Builder<ManagedKafkaEventSource>

A fluent builder for ManagedKafkaEventSource.

Method Summary

Modifier and Type	Method and Description
ManagedKafkaEventSource.Builder	batchSize(Number batchSize) The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
ManagedKafkaEventSource	build()
ManagedKafkaEventSource.Builder	clusterArn(String clusterArn) An MSK cluster construct.
static ManagedKafkaEventSource.Builder	create()
ManagedKafkaEventSource.Builder	enabled(Boolean enabled) If the stream event source mapping should be enabled.
ManagedKafkaEventSource.Builder	maxBatchingWindow(Duration maxBatchingWindow) The maximum amount of time to gather records before invoking the function.
ManagedKafkaEventSource.Builder	secret(ISecret secret) 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.
ManagedKafkaEventSource.Builder	startingPosition(StartingPosition startingPosition) Where to begin consuming the stream.
ManagedKafkaEventSource.Builder	topic(String topic) The Kafka topic to subscribe to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static ManagedKafkaEventSource.Builder create()

Returns:

a new instance of ManagedKafkaEventSource.Builder.

startingPosition

@Stability(value=Stable)
public ManagedKafkaEventSource.Builder startingPosition(StartingPosition startingPosition)

Where to begin consuming the stream.

Parameters:

startingPosition - Where to begin consuming the stream. This parameter is required.

Returns:

this

batchSize

@Stability(value=Stable)
public ManagedKafkaEventSource.Builder batchSize(Number batchSize)

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.

Your function receives an event with all the retrieved records.

Valid Range:

• Minimum value of 1
• Maximum value of:
  • 1000 for {@link DynamoEventSource}
  • 10000 for {@link KinesisEventSource}, {@link ManagedKafkaEventSource} and {@link SelfManagedKafkaEventSource}

Default: 100

Parameters:

batchSize - The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. This parameter is required.

Returns:

this

enabled

@Stability(value=Stable)
public ManagedKafkaEventSource.Builder enabled(Boolean enabled)

If the stream event source mapping should be enabled.

Default: true

Parameters:

enabled - If the stream event source mapping should be enabled. This parameter is required.

Returns:

this

maxBatchingWindow

@Stability(value=Stable)
public ManagedKafkaEventSource.Builder maxBatchingWindow(Duration maxBatchingWindow)

The maximum amount of time to gather records before invoking the function.

Maximum of Duration.minutes(5)

Default: Duration.seconds(0)

Parameters:

maxBatchingWindow - The maximum amount of time to gather records before invoking the function. This parameter is required.

Returns:

this

topic

@Stability(value=Stable)
public ManagedKafkaEventSource.Builder topic(String topic)

The Kafka topic to subscribe to.

Parameters:

topic - The Kafka topic to subscribe to. This parameter is required.

Returns:

this

secret

@Stability(value=Stable)
public ManagedKafkaEventSource.Builder secret(ISecret secret)

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

Parameters:

secret - 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. This parameter is required.

Returns:

this

clusterArn

@Stability(value=Stable)
public ManagedKafkaEventSource.Builder clusterArn(String clusterArn)

An MSK cluster construct.

Parameters:

clusterArn - An MSK cluster construct. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public ManagedKafkaEventSource build()

Specified by:

build in interface software.amazon.jsii.Builder<ManagedKafkaEventSource>