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

Class SqsEventSource.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<SqsEventSource>

Enclosing class:

SqsEventSource

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

A fluent builder for SqsEventSource.

Method Summary

Modifier and Type	Method	Description
SqsEventSource.Builder	batchSize(Number batchSize)	The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
SqsEventSource	build()
static SqsEventSource.Builder	create(IQueue queue)
SqsEventSource.Builder	enabled(Boolean enabled)	If the SQS event source mapping should be enabled.
SqsEventSource.Builder	filters(List<? extends Map<String,? extends Object>> filters)	Add filter criteria option.
SqsEventSource.Builder	maxBatchingWindow(Duration maxBatchingWindow)	The maximum amount of time to gather records before invoking the function.
SqsEventSource.Builder	maxConcurrency(Number maxConcurrency)	The maximum concurrency setting limits the number of concurrent instances of the function that an Amazon SQS event source can invoke.
SqsEventSource.Builder	reportBatchItemFailures(Boolean reportBatchItemFailures)	Allow functions to return partially successful responses for a batch of records.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static SqsEventSource.Builder create(IQueue queue)

Parameters:

queue - This parameter is required.

Returns:

a new instance of SqsEventSource.Builder.

batchSize

@Stability(Stable)
public SqsEventSource.Builder batchSize(Number 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 10. If maxBatchingWindow is configured, this value can go up to 10,000.

Default: 10

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

enabled

@Stability(Stable)
public SqsEventSource.Builder enabled(Boolean enabled)

If the SQS event source mapping should be enabled.

Default: true

Parameters:

enabled - If the SQS event source mapping should be enabled. This parameter is required.

Returns:

this

filters

@Stability(Stable)
public SqsEventSource.Builder filters(List<? extends Map<String,? extends Object>> filters)

Add filter criteria option.

Default: - None

Parameters:

filters - Add filter criteria option. This parameter is required.

Returns:

this

maxBatchingWindow

@Stability(Stable)
public SqsEventSource.Builder maxBatchingWindow(Duration maxBatchingWindow)

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

Valid Range: Minimum value of 0 minutes. Maximum value of 5 minutes.

Default: - no batching window. The lambda function will be invoked immediately with the records that are available.

Parameters:

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

Returns:

this

maxConcurrency

@Stability(Stable)
public SqsEventSource.Builder maxConcurrency(Number maxConcurrency)

The maximum concurrency setting limits the number of concurrent instances of the function that an Amazon SQS event source can invoke.

Default: - No specific limit.

Parameters:

maxConcurrency - The maximum concurrency setting limits the number of concurrent instances of the function that an Amazon SQS event source can invoke. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency Valid Range: Minimum value of 2. Maximum value of 1000.

reportBatchItemFailures

@Stability(Stable)
public SqsEventSource.Builder reportBatchItemFailures(Boolean reportBatchItemFailures)

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

Default: false

Parameters:

reportBatchItemFailures - Allow functions to return partially successful responses for a batch of records. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting

build

@Stability(Stable)
public SqsEventSource build()

Specified by:

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

Returns:

a newly built instance of SqsEventSource.