software.amazon.awscdk.services.lambda.eventsources

Class BaseStreamEventSourceProps.Builder

java.lang.Object

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

Enclosing interface:

BaseStreamEventSourceProps

public static final class BaseStreamEventSourceProps.Builder
extends java.lang.Object

A builder for BaseStreamEventSourceProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BaseStreamEventSourceProps.Builder	batchSize(java.lang.Number batchSize) Sets the value of BaseStreamEventSourceProps.getBatchSize()
BaseStreamEventSourceProps	build() Builds the configured instance.
BaseStreamEventSourceProps.Builder	enabled(java.lang.Boolean enabled) Sets the value of BaseStreamEventSourceProps.getEnabled()
BaseStreamEventSourceProps.Builder	maxBatchingWindow(Duration maxBatchingWindow) Sets the value of BaseStreamEventSourceProps.getMaxBatchingWindow()
BaseStreamEventSourceProps.Builder	startingPosition(StartingPosition startingPosition) Sets the value of BaseStreamEventSourceProps.getStartingPosition()

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

startingPosition

public BaseStreamEventSourceProps.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

public BaseStreamEventSourceProps.Builder batchSize(java.lang.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

public BaseStreamEventSourceProps.Builder enabled(java.lang.Boolean enabled)

Sets the value of BaseStreamEventSourceProps.getEnabled()

Parameters:

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

Returns:

this

maxBatchingWindow

public BaseStreamEventSourceProps.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

public BaseStreamEventSourceProps build()

Builds the configured instance.

Returns:

a new instance of BaseStreamEventSourceProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided