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

Interface SqsEventSourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SqsEventSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-08T14:57:08.304Z")
@Stability(Stable)
public interface SqsEventSourceProps
extends software.amazon.jsii.JsiiSerializable

Example:

 import software.amazon.awscdk.services.lambda.eventsources.SqsEventSource;
 Function fn;
 Queue queue = Queue.Builder.create(this, "MyQueue")
         .visibilityTimeout(Duration.seconds(30))
         .build();
 fn.addEventSource(SqsEventSource.Builder.create(queue)
         .batchSize(10) // default
         .maxBatchingWindow(Duration.minutes(5))
         .reportBatchItemFailures(true)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SqsEventSourceProps.Builder	A builder for SqsEventSourceProps
static final class	SqsEventSourceProps.Jsii$Proxy	An implementation for SqsEventSourceProps

Method Summary

Modifier and Type	Method	Description
static SqsEventSourceProps.Builder	builder()
default Number	getBatchSize()	The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
default Boolean	getEnabled()	If the SQS event source mapping should be enabled.
default IKey	getFilterEncryption()	Add Customer managed KMS key to encrypt Filter Criteria.
default List<Map<String,Object>>	getFilters()	Add filter criteria option.
default Duration	getMaxBatchingWindow()	The maximum amount of time to gather records before invoking the function.
default Number	getMaxConcurrency()	The maximum concurrency setting limits the number of concurrent instances of the function that an Amazon SQS event source can invoke.
default MetricsConfig	getMetricsConfig()	Configuration for enhanced monitoring metrics collection When specified, enables collection of additional metrics for the stream event source.
default Boolean	getReportBatchItemFailures()	Allow functions to return partially successful responses for a batch of records.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBatchSize

@Stability(Stable)
@Nullable
default Number getBatchSize()

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

getEnabled

@Stability(Stable)
@Nullable
default Boolean getEnabled()

If the SQS event source mapping should be enabled.

Default: true

getFilterEncryption

@Stability(Stable)
@Nullable
default IKey getFilterEncryption()

Add Customer managed KMS key to encrypt Filter Criteria.

Default: - none

See Also:

• https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk

getFilters

@Stability(Stable)
@Nullable
default List<Map<String,Object>> getFilters()

Add filter criteria option.

Default: - None

getMaxBatchingWindow

@Stability(Stable)
@Nullable
default Duration getMaxBatchingWindow()

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.

getMaxConcurrency

@Stability(Stable)
@Nullable
default Number getMaxConcurrency()

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.

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.

getMetricsConfig

@Stability(Stable)
@Nullable
default MetricsConfig getMetricsConfig()

Configuration for enhanced monitoring metrics collection When specified, enables collection of additional metrics for the stream event source.

Default: - Enhanced monitoring is disabled

getReportBatchItemFailures

@Stability(Stable)
@Nullable
default Boolean getReportBatchItemFailures()

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

Default: false

See Also:

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

builder

@Stability(Stable)
static SqsEventSourceProps.Builder builder()

Returns:

a SqsEventSourceProps.Builder of SqsEventSourceProps