software.amazon.awscdk.services.lambda

Class EventSourceMappingOptions.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.EventSourceMappingOptions.Builder

Enclosing interface:

EventSourceMappingOptions

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

A builder for EventSourceMappingOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
EventSourceMappingOptions.Builder	batchSize(java.lang.Number batchSize) Sets the value of EventSourceMappingOptions.getBatchSize()
EventSourceMappingOptions.Builder	bisectBatchOnError(java.lang.Boolean bisectBatchOnError) Sets the value of EventSourceMappingOptions.getBisectBatchOnError()
EventSourceMappingOptions	build() Builds the configured instance.
EventSourceMappingOptions.Builder	enabled(java.lang.Boolean enabled) Sets the value of EventSourceMappingOptions.getEnabled()
EventSourceMappingOptions.Builder	eventSourceArn(java.lang.String eventSourceArn) Sets the value of EventSourceMappingOptions.getEventSourceArn()
EventSourceMappingOptions.Builder	kafkaBootstrapServers(java.util.List<java.lang.String> kafkaBootstrapServers) Sets the value of EventSourceMappingOptions.getKafkaBootstrapServers()
EventSourceMappingOptions.Builder	kafkaTopic(java.lang.String kafkaTopic) Sets the value of EventSourceMappingOptions.getKafkaTopic()
EventSourceMappingOptions.Builder	maxBatchingWindow(Duration maxBatchingWindow) Sets the value of EventSourceMappingOptions.getMaxBatchingWindow()
EventSourceMappingOptions.Builder	maxRecordAge(Duration maxRecordAge) Sets the value of EventSourceMappingOptions.getMaxRecordAge()
EventSourceMappingOptions.Builder	onFailure(IEventSourceDlq onFailure) Sets the value of EventSourceMappingOptions.getOnFailure()
EventSourceMappingOptions.Builder	parallelizationFactor(java.lang.Number parallelizationFactor) Sets the value of EventSourceMappingOptions.getParallelizationFactor()
EventSourceMappingOptions.Builder	reportBatchItemFailures(java.lang.Boolean reportBatchItemFailures) Sets the value of EventSourceMappingOptions.getReportBatchItemFailures()
EventSourceMappingOptions.Builder	retryAttempts(java.lang.Number retryAttempts) Sets the value of EventSourceMappingOptions.getRetryAttempts()
EventSourceMappingOptions.Builder	sourceAccessConfigurations(java.util.List<? extends SourceAccessConfiguration> sourceAccessConfigurations) Sets the value of EventSourceMappingOptions.getSourceAccessConfigurations()
EventSourceMappingOptions.Builder	startingPosition(StartingPosition startingPosition) Sets the value of EventSourceMappingOptions.getStartingPosition()
EventSourceMappingOptions.Builder	tumblingWindow(Duration tumblingWindow) Sets the value of EventSourceMappingOptions.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

batchSize

public EventSourceMappingOptions.Builder batchSize(java.lang.Number batchSize)

Sets the value of EventSourceMappingOptions.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 10000.

Returns:

this

bisectBatchOnError

public EventSourceMappingOptions.Builder bisectBatchOnError(java.lang.Boolean bisectBatchOnError)

Sets the value of EventSourceMappingOptions.getBisectBatchOnError()

Parameters:

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

Returns:

this

enabled

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

Sets the value of EventSourceMappingOptions.getEnabled()

Parameters:

enabled - Set to false to disable the event source upon creation.

Returns:

this

eventSourceArn

public EventSourceMappingOptions.Builder eventSourceArn(java.lang.String eventSourceArn)

Sets the value of EventSourceMappingOptions.getEventSourceArn()

Parameters:

eventSourceArn - The Amazon Resource Name (ARN) of the event source. Any record added to this stream can invoke the Lambda function.

Returns:

this

kafkaBootstrapServers

public EventSourceMappingOptions.Builder kafkaBootstrapServers(java.util.List<java.lang.String> kafkaBootstrapServers)

Sets the value of EventSourceMappingOptions.getKafkaBootstrapServers()

Parameters:

kafkaBootstrapServers - A list of host and port pairs that are the addresses of the Kafka brokers in a self managed "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself. They are in the format abc.example.com:9096.

Returns:

this

kafkaTopic

public EventSourceMappingOptions.Builder kafkaTopic(java.lang.String kafkaTopic)

Sets the value of EventSourceMappingOptions.getKafkaTopic()

Parameters:

kafkaTopic - The name of the Kafka topic.

Returns:

this

maxBatchingWindow

public EventSourceMappingOptions.Builder maxBatchingWindow(Duration maxBatchingWindow)

Sets the value of EventSourceMappingOptions.getMaxBatchingWindow()

Parameters:

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

Returns:

this

maxRecordAge

public EventSourceMappingOptions.Builder maxRecordAge(Duration maxRecordAge)

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

public EventSourceMappingOptions.Builder onFailure(IEventSourceDlq onFailure)

Sets the value of EventSourceMappingOptions.getOnFailure()

Parameters:

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

Returns:

this

parallelizationFactor

public EventSourceMappingOptions.Builder parallelizationFactor(java.lang.Number parallelizationFactor)

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

reportBatchItemFailures

public EventSourceMappingOptions.Builder reportBatchItemFailures(java.lang.Boolean reportBatchItemFailures)

Sets the value of EventSourceMappingOptions.getReportBatchItemFailures()

Parameters:

reportBatchItemFailures - Allow functions to return partially successful responses for a batch of records.

Returns:

this

retryAttempts

public EventSourceMappingOptions.Builder retryAttempts(java.lang.Number retryAttempts)

Sets the value of EventSourceMappingOptions.getRetryAttempts()

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. Set to undefined if you want lambda to keep retrying infinitely or until the record expires.

Valid Range:

• Minimum value of 0
• Maximum value of 10000

Returns:

this

sourceAccessConfigurations

public EventSourceMappingOptions.Builder sourceAccessConfigurations(java.util.List<? extends SourceAccessConfiguration> sourceAccessConfigurations)

Sets the value of EventSourceMappingOptions.getSourceAccessConfigurations()

Parameters:

sourceAccessConfigurations - Specific settings like the authentication protocol or the VPC components to secure access to your event source.

Returns:

this

startingPosition

public EventSourceMappingOptions.Builder startingPosition(StartingPosition startingPosition)

Sets the value of EventSourceMappingOptions.getStartingPosition()

Parameters:

startingPosition - The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading.

Returns:

this

tumblingWindow

public EventSourceMappingOptions.Builder tumblingWindow(Duration tumblingWindow)

Sets the value of EventSourceMappingOptions.getTumblingWindow()

Parameters:

tumblingWindow - The size of the tumbling windows to group records sent to DynamoDB or Kinesis.

Returns:

this

build

public EventSourceMappingOptions build()

Builds the configured instance.

Returns:

a new instance of EventSourceMappingOptions

Throws:

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