Interface UpdateEventSourceMappingRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateEventSourceMappingRequest.Builder,
,UpdateEventSourceMappingRequest> LambdaRequest.Builder
,SdkBuilder<UpdateEventSourceMappingRequest.Builder,
,UpdateEventSourceMappingRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateEventSourceMappingRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.bisectBatchOnFunctionError
(Boolean bisectBatchOnFunctionError) (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.destinationConfig
(Consumer<DestinationConfig.Builder> destinationConfig) (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.destinationConfig
(DestinationConfig destinationConfig) (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.documentDBEventSourceConfig
(Consumer<DocumentDBEventSourceConfig.Builder> documentDBEventSourceConfig) Specific configuration settings for a DocumentDB event source.documentDBEventSourceConfig
(DocumentDBEventSourceConfig documentDBEventSourceConfig) Specific configuration settings for a DocumentDB event source.When true, the event source mapping is active.filterCriteria
(Consumer<FilterCriteria.Builder> filterCriteria) An object that defines the filter criteria that determine whether Lambda should process an event.filterCriteria
(FilterCriteria filterCriteria) An object that defines the filter criteria that determine whether Lambda should process an event.functionName
(String functionName) The name or ARN of the Lambda function.functionResponseTypes
(Collection<FunctionResponseType> functionResponseTypes) (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.functionResponseTypes
(FunctionResponseType... functionResponseTypes) (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.functionResponseTypesWithStrings
(String... functionResponseTypes) (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.functionResponseTypesWithStrings
(Collection<String> functionResponseTypes) (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.maximumBatchingWindowInSeconds
(Integer maximumBatchingWindowInSeconds) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.maximumRecordAgeInSeconds
(Integer maximumRecordAgeInSeconds) (Kinesis and DynamoDB Streams only) Discard records older than the specified age.maximumRetryAttempts
(Integer maximumRetryAttempts) (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.parallelizationFactor
(Integer parallelizationFactor) (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.scalingConfig
(Consumer<ScalingConfig.Builder> scalingConfig) (Amazon SQS only) The scaling configuration for the event source.scalingConfig
(ScalingConfig scalingConfig) (Amazon SQS only) The scaling configuration for the event source.sourceAccessConfigurations
(Collection<SourceAccessConfiguration> sourceAccessConfigurations) An array of authentication protocols or VPC components required to secure your event source.sourceAccessConfigurations
(Consumer<SourceAccessConfiguration.Builder>... sourceAccessConfigurations) An array of authentication protocols or VPC components required to secure your event source.sourceAccessConfigurations
(SourceAccessConfiguration... sourceAccessConfigurations) An array of authentication protocols or VPC components required to secure your event source.tumblingWindowInSeconds
(Integer tumblingWindowInSeconds) (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.The identifier of the event source mapping.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.lambda.model.LambdaRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
uuid
The identifier of the event source mapping.
- Parameters:
uuid
- The identifier of the event source mapping.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
functionName
The name or ARN of the Lambda function.
Name formats
-
Function name –
MyFunction
. -
Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:MyFunction
. -
Version or Alias ARN –
arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
. -
Partial ARN –
123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
- Parameters:
functionName
- The name or ARN of the Lambda function.Name formats
-
Function name –
MyFunction
. -
Function ARN –
arn:aws:lambda:us-west-2:123456789012:function:MyFunction
. -
Version or Alias ARN –
arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
. -
Partial ARN –
123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
enabled
When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
- Parameters:
enabled
- When true, the event source mapping is active. When false, Lambda pauses polling and invocation.Default: True
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
batchSize
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
-
Amazon Kinesis – Default 100. Max 10,000.
-
Amazon DynamoDB Streams – Default 100. Max 10,000.
-
Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
-
Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
-
Self-managed Apache Kafka – Default 100. Max 10,000.
-
Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
-
DocumentDB – Default 100. Max 10,000.
- Parameters:
batchSize
- The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).-
Amazon Kinesis – Default 100. Max 10,000.
-
Amazon DynamoDB Streams – Default 100. Max 10,000.
-
Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
-
Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
-
Self-managed Apache Kafka – Default 100. Max 10,000.
-
Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
-
DocumentDB – Default 100. Max 10,000.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filterCriteria
An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
- Parameters:
filterCriteria
- An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filterCriteria
default UpdateEventSourceMappingRequest.Builder filterCriteria(Consumer<FilterCriteria.Builder> filterCriteria) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
This is a convenience method that creates an instance of theFilterCriteria.Builder
avoiding the need to create one manually viaFilterCriteria.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilterCriteria(FilterCriteria)
.- Parameters:
filterCriteria
- a consumer that will call methods onFilterCriteria.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maximumBatchingWindowInSeconds
UpdateEventSourceMappingRequest.Builder maximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure
MaximumBatchingWindowInSeconds
to any value from 0 seconds to 300 seconds in increments of seconds.For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change
MaximumBatchingWindowInSeconds
in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.Related setting: For streams and Amazon SQS event sources, when you set
BatchSize
to a value greater than 10, you must setMaximumBatchingWindowInSeconds
to at least 1.- Parameters:
maximumBatchingWindowInSeconds
- The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configureMaximumBatchingWindowInSeconds
to any value from 0 seconds to 300 seconds in increments of seconds.For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change
MaximumBatchingWindowInSeconds
in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.Related setting: For streams and Amazon SQS event sources, when you set
BatchSize
to a value greater than 10, you must setMaximumBatchingWindowInSeconds
to at least 1.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationConfig
(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.
- Parameters:
destinationConfig
- (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationConfig
default UpdateEventSourceMappingRequest.Builder destinationConfig(Consumer<DestinationConfig.Builder> destinationConfig) (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.
This is a convenience method that creates an instance of theDestinationConfig.Builder
avoiding the need to create one manually viaDestinationConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todestinationConfig(DestinationConfig)
.- Parameters:
destinationConfig
- a consumer that will call methods onDestinationConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maximumRecordAgeInSeconds
UpdateEventSourceMappingRequest.Builder maximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds) (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).
- Parameters:
maximumRecordAgeInSeconds
- (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bisectBatchOnFunctionError
UpdateEventSourceMappingRequest.Builder bisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError) (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
- Parameters:
bisectBatchOnFunctionError
- (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maximumRetryAttempts
(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
- Parameters:
maximumRetryAttempts
- (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parallelizationFactor
(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
- Parameters:
parallelizationFactor
- (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceAccessConfigurations
UpdateEventSourceMappingRequest.Builder sourceAccessConfigurations(Collection<SourceAccessConfiguration> sourceAccessConfigurations) An array of authentication protocols or VPC components required to secure your event source.
- Parameters:
sourceAccessConfigurations
- An array of authentication protocols or VPC components required to secure your event source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceAccessConfigurations
UpdateEventSourceMappingRequest.Builder sourceAccessConfigurations(SourceAccessConfiguration... sourceAccessConfigurations) An array of authentication protocols or VPC components required to secure your event source.
- Parameters:
sourceAccessConfigurations
- An array of authentication protocols or VPC components required to secure your event source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceAccessConfigurations
UpdateEventSourceMappingRequest.Builder sourceAccessConfigurations(Consumer<SourceAccessConfiguration.Builder>... sourceAccessConfigurations) An array of authentication protocols or VPC components required to secure your event source.
This is a convenience method that creates an instance of theSourceAccessConfiguration.Builder
avoiding the need to create one manually viaSourceAccessConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceAccessConfigurations(List<SourceAccessConfiguration>)
.- Parameters:
sourceAccessConfigurations
- a consumer that will call methods onSourceAccessConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tumblingWindowInSeconds
(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
- Parameters:
tumblingWindowInSeconds
- (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
functionResponseTypesWithStrings
UpdateEventSourceMappingRequest.Builder functionResponseTypesWithStrings(Collection<String> functionResponseTypes) (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
- Parameters:
functionResponseTypes
- (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
functionResponseTypesWithStrings
UpdateEventSourceMappingRequest.Builder functionResponseTypesWithStrings(String... functionResponseTypes) (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
- Parameters:
functionResponseTypes
- (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
functionResponseTypes
UpdateEventSourceMappingRequest.Builder functionResponseTypes(Collection<FunctionResponseType> functionResponseTypes) (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
- Parameters:
functionResponseTypes
- (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
functionResponseTypes
UpdateEventSourceMappingRequest.Builder functionResponseTypes(FunctionResponseType... functionResponseTypes) (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
- Parameters:
functionResponseTypes
- (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scalingConfig
(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
- Parameters:
scalingConfig
- (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scalingConfig
default UpdateEventSourceMappingRequest.Builder scalingConfig(Consumer<ScalingConfig.Builder> scalingConfig) (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
This is a convenience method that creates an instance of theScalingConfig.Builder
avoiding the need to create one manually viaScalingConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toscalingConfig(ScalingConfig)
.- Parameters:
scalingConfig
- a consumer that will call methods onScalingConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
documentDBEventSourceConfig
UpdateEventSourceMappingRequest.Builder documentDBEventSourceConfig(DocumentDBEventSourceConfig documentDBEventSourceConfig) Specific configuration settings for a DocumentDB event source.
- Parameters:
documentDBEventSourceConfig
- Specific configuration settings for a DocumentDB event source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentDBEventSourceConfig
default UpdateEventSourceMappingRequest.Builder documentDBEventSourceConfig(Consumer<DocumentDBEventSourceConfig.Builder> documentDBEventSourceConfig) Specific configuration settings for a DocumentDB event source.
This is a convenience method that creates an instance of theDocumentDBEventSourceConfig.Builder
avoiding the need to create one manually viaDocumentDBEventSourceConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocumentDBEventSourceConfig(DocumentDBEventSourceConfig)
.- Parameters:
documentDBEventSourceConfig
- a consumer that will call methods onDocumentDBEventSourceConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
UpdateEventSourceMappingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateEventSourceMappingRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-