Package software.amazon.awscdk.services.lambda.eventsources

Class BaseStreamEventSourceProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<BaseStreamEventSourceProps>

Enclosing interface:

BaseStreamEventSourceProps

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

A builder for BaseStreamEventSourceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BaseStreamEventSourceProps.Builder	batchSize(Number batchSize)	Sets the value of BaseStreamEventSourceProps.getBatchSize()
BaseStreamEventSourceProps	build()	Builds the configured instance.
BaseStreamEventSourceProps.Builder	enabled(Boolean enabled)	Sets the value of BaseStreamEventSourceProps.getEnabled()
BaseStreamEventSourceProps.Builder	maxBatchingWindow(Duration maxBatchingWindow)	Sets the value of BaseStreamEventSourceProps.getMaxBatchingWindow()
BaseStreamEventSourceProps.Builder	provisionedPollerConfig(ProvisionedPollerConfig provisionedPollerConfig)	Sets the value of BaseStreamEventSourceProps.getProvisionedPollerConfig()
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 Details

Builder

public Builder()

Method Details

startingPosition

@Stability(Stable)
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

@Stability(Stable)
public BaseStreamEventSourceProps.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 DynamoEventSource
  • 10000 for KinesisEventSource, ManagedKafkaEventSource and SelfManagedKafkaEventSource

Returns:

this

enabled

@Stability(Stable)
public BaseStreamEventSourceProps.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(Stable)
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

provisionedPollerConfig

@Stability(Stable)
public BaseStreamEventSourceProps.Builder provisionedPollerConfig(ProvisionedPollerConfig provisionedPollerConfig)

Sets the value of BaseStreamEventSourceProps.getProvisionedPollerConfig()

Parameters:

provisionedPollerConfig - Configuration for provisioned pollers that read from the event source. When specified, allows control over the minimum and maximum number of pollers that can be provisioned to process events from the source.

Returns:

this

build

@Stability(Stable)
public BaseStreamEventSourceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of BaseStreamEventSourceProps

Throws:

NullPointerException - if any required attribute was not provided