software.amazon.awscdk.services.lambda

Class EventSourceMapping.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.EventSourceMapping.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EventSourceMapping>

Enclosing class:

EventSourceMapping

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

(experimental) A fluent builder for EventSourceMapping.

Method Summary

Modifier and Type	Method and Description
EventSourceMapping.Builder	batchSize(Number batchSize) (experimental) The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
EventSourceMapping.Builder	bisectBatchOnError(Boolean bisectBatchOnError) (experimental) If the function returns an error, split the batch in two and retry.
EventSourceMapping	build()
static EventSourceMapping.Builder	create(software.constructs.Construct scope, String id)
EventSourceMapping.Builder	enabled(Boolean enabled) (experimental) Set to false to disable the event source upon creation.
EventSourceMapping.Builder	eventSourceArn(String eventSourceArn) (experimental) The Amazon Resource Name (ARN) of the event source.
EventSourceMapping.Builder	kafkaBootstrapServers(List<String> kafkaBootstrapServers) (experimental) 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.
EventSourceMapping.Builder	kafkaTopic(String kafkaTopic) (experimental) The name of the Kafka topic.
EventSourceMapping.Builder	maxBatchingWindow(Duration maxBatchingWindow) (experimental) The maximum amount of time to gather records before invoking the function.
EventSourceMapping.Builder	maxRecordAge(Duration maxRecordAge) (experimental) The maximum age of a record that Lambda sends to a function for processing.
EventSourceMapping.Builder	onFailure(IEventSourceDlq onFailure) (experimental) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
EventSourceMapping.Builder	parallelizationFactor(Number parallelizationFactor) (experimental) The number of batches to process from each shard concurrently.
EventSourceMapping.Builder	retryAttempts(Number retryAttempts) (experimental) The maximum number of times to retry when the function returns an error.
EventSourceMapping.Builder	sourceAccessConfigurations(List<? extends SourceAccessConfiguration> sourceAccessConfigurations) (experimental) Specific settings like the authentication protocol or the VPC components to secure access to your event source.
EventSourceMapping.Builder	startingPosition(StartingPosition startingPosition) (experimental) The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading.
EventSourceMapping.Builder	target(IFunction target) (experimental) The target AWS Lambda function.
EventSourceMapping.Builder	tumblingWindow(Duration tumblingWindow) (experimental) The size of the tumbling windows to group records sent to DynamoDB or Kinesis.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static EventSourceMapping.Builder create(software.constructs.Construct scope,
                                                                               String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of EventSourceMapping.Builder.

batchSize

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

(experimental) 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.

Default: - Amazon Kinesis, Amazon DynamoDB, and Amazon MSK is 100 records. Both the default and maximum for Amazon SQS are 10 messages.

Parameters:

batchSize - The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. This parameter is required.

Returns:

this

bisectBatchOnError

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

(experimental) If the function returns an error, split the batch in two and retry.

Default: false

Parameters:

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

Returns:

this

enabled

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

(experimental) Set to false to disable the event source upon creation.

Default: true

Parameters:

enabled - Set to false to disable the event source upon creation. This parameter is required.

Returns:

this

eventSourceArn

@Stability(value=Experimental)
public EventSourceMapping.Builder eventSourceArn(String eventSourceArn)

(experimental) The Amazon Resource Name (ARN) of the event source.

Any record added to this stream can invoke the Lambda function.

Default: - not set if using a self managed Kafka cluster, throws an error otherwise

Parameters:

eventSourceArn - The Amazon Resource Name (ARN) of the event source. This parameter is required.

Returns:

this

kafkaBootstrapServers

@Stability(value=Experimental)
public EventSourceMapping.Builder kafkaBootstrapServers(List<String> kafkaBootstrapServers)

(experimental) 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.

Default: - none

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. This parameter is required.

Returns:

this

kafkaTopic

@Stability(value=Experimental)
public EventSourceMapping.Builder kafkaTopic(String kafkaTopic)

(experimental) The name of the Kafka topic.

Default: - no topic

Parameters:

kafkaTopic - The name of the Kafka topic. This parameter is required.

Returns:

this

maxBatchingWindow

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

(experimental) The maximum amount of time to gather records before invoking the function.

Maximum of Duration.minutes(5)

Default: Duration.seconds(0)

Parameters:

maxBatchingWindow - The maximum amount of time to gather records before invoking the function. This parameter is required.

Returns:

this

maxRecordAge

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

(experimental) 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

Default: - infinite or until the record expires.

Parameters:

maxRecordAge - The maximum age of a record that Lambda sends to a function for processing. This parameter is required.

Returns:

this

onFailure

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

(experimental) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

Default: discarded records are ignored

Parameters:

onFailure - An Amazon SQS queue or Amazon SNS topic destination for discarded records. This parameter is required.

Returns:

this

parallelizationFactor

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

(experimental) The number of batches to process from each shard concurrently.

Valid Range:

• Minimum value of 1
• Maximum value of 10

Default: 1

Parameters:

parallelizationFactor - The number of batches to process from each shard concurrently. This parameter is required.

Returns:

this

retryAttempts

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

(experimental) 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

Default: - infinite or until the record expires.

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. This parameter is required.

Returns:

this

sourceAccessConfigurations

@Stability(value=Experimental)
public EventSourceMapping.Builder sourceAccessConfigurations(List<? extends SourceAccessConfiguration> sourceAccessConfigurations)

(experimental) Specific settings like the authentication protocol or the VPC components to secure access to your event source.

Default: - none

Parameters:

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

Returns:

this

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html

startingPosition

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

(experimental) The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading.

Default: - Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources.

Parameters:

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

Returns:

this

See Also:

https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType

tumblingWindow

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

(experimental) The size of the tumbling windows to group records sent to DynamoDB or Kinesis.

Default: - None

Parameters:

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

Returns:

this

See Also:

Valid Range: 0 - 15 minutes

target

@Stability(value=Experimental)
public EventSourceMapping.Builder target(IFunction target)

(experimental) The target AWS Lambda function.

Parameters:

target - The target AWS Lambda function. This parameter is required.

Returns:

this

build

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

Specified by:

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