Interface SqsEventSourceProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
SqsEventSourceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
date="2024-08-15T01:32:50.482Z")
@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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forSqsEventSourceProps
static final class
An implementation forSqsEventSourceProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic SqsEventSourceProps.Builder
builder()
default Number
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.default Boolean
If the SQS event source mapping should be enabled.default IKey
Add Customer managed KMS key to encrypt Filter Criteria.Add filter criteria option.default Duration
The maximum amount of time to gather records before invoking the function.default Number
The maximum concurrency setting limits the number of concurrent instances of the function that an Amazon SQS event source can invoke.default Boolean
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
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
If the SQS event source mapping should be enabled.Default: true
-
getFilterEncryption
Add Customer managed KMS key to encrypt Filter Criteria.Default: - none
- See Also:
-
getFilters
Add filter criteria option.Default: - None
-
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
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:
-
getReportBatchItemFailures
Allow functions to return partially successful responses for a batch of records.Default: false
- See Also:
-
builder
- Returns:
- a
SqsEventSourceProps.Builder
ofSqsEventSourceProps
-