software.amazon.awscdk.services.lambda.eventsources

Class KinesisEventSourceProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<KinesisEventSourceProps>

Enclosing interface:

KinesisEventSourceProps

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

A builder for KinesisEventSourceProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
KinesisEventSourceProps.Builder	batchSize(Number batchSize) Sets the value of StreamEventSourceProps.getBatchSize()
KinesisEventSourceProps.Builder	bisectBatchOnError(Boolean bisectBatchOnError) Sets the value of StreamEventSourceProps.getBisectBatchOnError()
KinesisEventSourceProps	build() Builds the configured instance.
KinesisEventSourceProps.Builder	enabled(Boolean enabled) Sets the value of StreamEventSourceProps.getEnabled()
KinesisEventSourceProps.Builder	maxBatchingWindow(Duration maxBatchingWindow) Sets the value of StreamEventSourceProps.getMaxBatchingWindow()
KinesisEventSourceProps.Builder	maxRecordAge(Duration maxRecordAge) Sets the value of StreamEventSourceProps.getMaxRecordAge()
KinesisEventSourceProps.Builder	onFailure(IEventSourceDlq onFailure) Sets the value of StreamEventSourceProps.getOnFailure()
KinesisEventSourceProps.Builder	parallelizationFactor(Number parallelizationFactor) Sets the value of StreamEventSourceProps.getParallelizationFactor()
KinesisEventSourceProps.Builder	retryAttempts(Number retryAttempts) Sets the value of StreamEventSourceProps.getRetryAttempts()
KinesisEventSourceProps.Builder	startingPosition(StartingPosition startingPosition) Sets the value of StreamEventSourceProps.getStartingPosition()
KinesisEventSourceProps.Builder	tumblingWindow(Duration tumblingWindow) Sets the value of StreamEventSourceProps.getTumblingWindow()

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

@Stability(value=Experimental)
public KinesisEventSourceProps.Builder startingPosition(StartingPosition startingPosition)

Sets the value of StreamEventSourceProps.getStartingPosition()

Parameters:

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

Returns:

this

batchSize

@Stability(value=Experimental)
public KinesisEventSourceProps.Builder batchSize(Number batchSize)

Sets the value of StreamEventSourceProps.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}

Returns:

this

bisectBatchOnError

@Stability(value=Experimental)
public KinesisEventSourceProps.Builder bisectBatchOnError(Boolean bisectBatchOnError)

Sets the value of StreamEventSourceProps.getBisectBatchOnError()

Parameters:

bisectBatchOnError - If the function returns an error, split the batch in two and retry.

Returns:

this

enabled

@Stability(value=Experimental)
public KinesisEventSourceProps.Builder enabled(Boolean enabled)

Sets the value of StreamEventSourceProps.getEnabled()

Parameters:

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

Returns:

this

maxBatchingWindow

@Stability(value=Experimental)
public KinesisEventSourceProps.Builder maxBatchingWindow(Duration maxBatchingWindow)

Sets the value of StreamEventSourceProps.getMaxBatchingWindow()

Parameters:

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

Returns:

this

maxRecordAge

@Stability(value=Experimental)
public KinesisEventSourceProps.Builder maxRecordAge(Duration maxRecordAge)

Sets the value of StreamEventSourceProps.getMaxRecordAge()

Parameters:

maxRecordAge - The maximum age of a record that Lambda sends to a function for processing. Valid Range:

• Minimum value of 60 seconds
• Maximum value of 7 days

Returns:

this

onFailure

@Stability(value=Experimental)
public KinesisEventSourceProps.Builder onFailure(IEventSourceDlq onFailure)

Sets the value of StreamEventSourceProps.getOnFailure()

Parameters:

onFailure - An Amazon SQS queue or Amazon SNS topic destination for discarded records.

Returns:

this

parallelizationFactor

@Stability(value=Experimental)
public KinesisEventSourceProps.Builder parallelizationFactor(Number parallelizationFactor)

Sets the value of StreamEventSourceProps.getParallelizationFactor()

Parameters:

parallelizationFactor - The number of batches to process from each shard concurrently. Valid Range:

• Minimum value of 1
• Maximum value of 10

Returns:

this

retryAttempts

@Stability(value=Experimental)
public KinesisEventSourceProps.Builder retryAttempts(Number retryAttempts)

Sets the value of StreamEventSourceProps.getRetryAttempts()

Parameters:

retryAttempts - Maximum number of retry attempts Valid Range: * Minimum value of 0 * Maximum value of 10000.

Returns:

this

tumblingWindow

@Stability(value=Experimental)
public KinesisEventSourceProps.Builder tumblingWindow(Duration tumblingWindow)

Sets the value of StreamEventSourceProps.getTumblingWindow()

Parameters:

tumblingWindow - The size of the tumbling windows to group records sent to DynamoDB or Kinesis Valid Range: 0 - 15 minutes.

Returns:

this

build

@Stability(value=Experimental)
public KinesisEventSourceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of KinesisEventSourceProps

Throws:

NullPointerException - if any required attribute was not provided