software.amazon.awscdk.services.lambda.eventsources

Class KafkaEventSourceProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<KafkaEventSourceProps>

Enclosing interface:

KafkaEventSourceProps

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

A builder for KafkaEventSourceProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
KafkaEventSourceProps.Builder	batchSize(Number batchSize) Sets the value of BaseStreamEventSourceProps.getBatchSize()
KafkaEventSourceProps	build() Builds the configured instance.
KafkaEventSourceProps.Builder	consumerGroupId(String consumerGroupId) Sets the value of KafkaEventSourceProps.getConsumerGroupId()
KafkaEventSourceProps.Builder	enabled(Boolean enabled) Sets the value of BaseStreamEventSourceProps.getEnabled()
KafkaEventSourceProps.Builder	maxBatchingWindow(Duration maxBatchingWindow) Sets the value of BaseStreamEventSourceProps.getMaxBatchingWindow()
KafkaEventSourceProps.Builder	secret(ISecret secret) Sets the value of KafkaEventSourceProps.getSecret()
KafkaEventSourceProps.Builder	startingPosition(StartingPosition startingPosition) Sets the value of BaseStreamEventSourceProps.getStartingPosition()
KafkaEventSourceProps.Builder	topic(String topic) Sets the value of KafkaEventSourceProps.getTopic()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

topic

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

Sets the value of KafkaEventSourceProps.getTopic()

Parameters:

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

Returns:

this

consumerGroupId

@Stability(value=Stable)
public KafkaEventSourceProps.Builder consumerGroupId(String consumerGroupId)

Sets the value of KafkaEventSourceProps.getConsumerGroupId()

Parameters:

consumerGroupId - 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-/:_+=.@-]'.

Returns:

this

secret

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

Sets the value of KafkaEventSourceProps.getSecret()

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.

Returns:

this

startingPosition

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

Sets the value of BaseStreamEventSourceProps.getStartingPosition()

Parameters:

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

Returns:

this

batchSize

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

Sets the value of BaseStreamEventSourceProps.getBatchSize()

Parameters:

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}

Returns:

this

enabled

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

Sets the value of BaseStreamEventSourceProps.getEnabled()

Parameters:

enabled - If the stream event source mapping should be enabled.

Returns:

this

maxBatchingWindow

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

Sets the value of BaseStreamEventSourceProps.getMaxBatchingWindow()

Parameters:

maxBatchingWindow - The maximum amount of time to gather records before invoking the function. Maximum of Duration.minutes(5).

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of KafkaEventSourceProps

Throws:

NullPointerException - if any required attribute was not provided