UpdateEventSourceMappingRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.lambda.model

Class UpdateEventSourceMappingRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.lambda.model.UpdateEventSourceMappingRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateEventSourceMappingRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

UpdateEventSourceMappingRequest ()

Constructors
Constructor and Description
`UpdateEventSourceMappingRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`UpdateEventSourceMappingRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`Integer`	`getBatchSize ()` The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.
`Boolean`	`getBisectBatchOnFunctionError ()` (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
`DestinationConfig`	`getDestinationConfig ()` (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`	`getDocumentDBEventSourceConfig ()` Specific configuration settings for a DocumentDB event source.
`Boolean`	`getEnabled ()` When true, the event source mapping is active.
`FilterCriteria`	`getFilterCriteria ()` An object that defines the filter criteria that determine whether Lambda should process an event.
`String`	`getFunctionName ()` The name or ARN of the Lambda function.
`List<String>`	`getFunctionResponseTypes ()` (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
`Integer`	`getMaximumBatchingWindowInSeconds ()` The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
`Integer`	`getMaximumRecordAgeInSeconds ()` (Kinesis and DynamoDB Streams only) Discard records older than the specified age.
`Integer`	`getMaximumRetryAttempts ()` (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.
`Integer`	`getParallelizationFactor ()` (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
`ScalingConfig`	`getScalingConfig ()` (Amazon SQS only) The scaling configuration for the event source.
`List<SourceAccessConfiguration>`	`getSourceAccessConfigurations ()` An array of authentication protocols or VPC components required to secure your event source.
`Integer`	`getTumblingWindowInSeconds ()` (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.
`String`	`getUUID ()` The identifier of the event source mapping.
`int`	`hashCode ()`
`Boolean`	`isBisectBatchOnFunctionError ()` (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
`Boolean`	`isEnabled ()` When true, the event source mapping is active.
`void`	`setBatchSize (Integer batchSize)` The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.
`void`	`setBisectBatchOnFunctionError (Boolean bisectBatchOnFunctionError)` (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
`void`	`setDestinationConfig (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.
`void`	`setDocumentDBEventSourceConfig (DocumentDBEventSourceConfig documentDBEventSourceConfig)` Specific configuration settings for a DocumentDB event source.
`void`	`setEnabled (Boolean enabled)` When true, the event source mapping is active.
`void`	`setFilterCriteria (FilterCriteria filterCriteria)` An object that defines the filter criteria that determine whether Lambda should process an event.
`void`	`setFunctionName (String functionName)` The name or ARN of the Lambda function.
`void`	`setFunctionResponseTypes (Collection<String> functionResponseTypes)` (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
`void`	`setMaximumBatchingWindowInSeconds (Integer maximumBatchingWindowInSeconds)` The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
`void`	`setMaximumRecordAgeInSeconds (Integer maximumRecordAgeInSeconds)` (Kinesis and DynamoDB Streams only) Discard records older than the specified age.
`void`	`setMaximumRetryAttempts (Integer maximumRetryAttempts)` (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.
`void`	`setParallelizationFactor (Integer parallelizationFactor)` (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
`void`	`setScalingConfig (ScalingConfig scalingConfig)` (Amazon SQS only) The scaling configuration for the event source.
`void`	`setSourceAccessConfigurations (Collection<SourceAccessConfiguration> sourceAccessConfigurations)` An array of authentication protocols or VPC components required to secure your event source.
`void`	`setTumblingWindowInSeconds (Integer tumblingWindowInSeconds)` (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.
`void`	`setUUID (String uUID)` The identifier of the event source mapping.
`String`	`toString ()` Returns a string representation of this object.
`UpdateEventSourceMappingRequest`	`withBatchSize (Integer batchSize)` The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.
`UpdateEventSourceMappingRequest`	`withBisectBatchOnFunctionError (Boolean bisectBatchOnFunctionError)` (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
`UpdateEventSourceMappingRequest`	`withDestinationConfig (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.
`UpdateEventSourceMappingRequest`	`withDocumentDBEventSourceConfig (DocumentDBEventSourceConfig documentDBEventSourceConfig)` Specific configuration settings for a DocumentDB event source.
`UpdateEventSourceMappingRequest`	`withEnabled (Boolean enabled)` When true, the event source mapping is active.
`UpdateEventSourceMappingRequest`	`withFilterCriteria (FilterCriteria filterCriteria)` An object that defines the filter criteria that determine whether Lambda should process an event.
`UpdateEventSourceMappingRequest`	`withFunctionName (String functionName)` The name or ARN of the Lambda function.
`UpdateEventSourceMappingRequest`	`withFunctionResponseTypes (Collection<String> functionResponseTypes)` (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
`UpdateEventSourceMappingRequest`	`withFunctionResponseTypes (FunctionResponseType... functionResponseTypes)` (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
`UpdateEventSourceMappingRequest`	`withFunctionResponseTypes (String... functionResponseTypes)` (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
`UpdateEventSourceMappingRequest`	`withMaximumBatchingWindowInSeconds (Integer maximumBatchingWindowInSeconds)` The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
`UpdateEventSourceMappingRequest`	`withMaximumRecordAgeInSeconds (Integer maximumRecordAgeInSeconds)` (Kinesis and DynamoDB Streams only) Discard records older than the specified age.
`UpdateEventSourceMappingRequest`	`withMaximumRetryAttempts (Integer maximumRetryAttempts)` (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.
`UpdateEventSourceMappingRequest`	`withParallelizationFactor (Integer parallelizationFactor)` (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
`UpdateEventSourceMappingRequest`	`withScalingConfig (ScalingConfig scalingConfig)` (Amazon SQS only) The scaling configuration for the event source.
`UpdateEventSourceMappingRequest`	`withSourceAccessConfigurations (Collection<SourceAccessConfiguration> sourceAccessConfigurations)` An array of authentication protocols or VPC components required to secure your event source.
`UpdateEventSourceMappingRequest`	`withSourceAccessConfigurations (SourceAccessConfiguration... sourceAccessConfigurations)` An array of authentication protocols or VPC components required to secure your event source.
`UpdateEventSourceMappingRequest`	`withTumblingWindowInSeconds (Integer tumblingWindowInSeconds)` (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.
`UpdateEventSourceMappingRequest`	`withUUID (String uUID)` The identifier of the event source mapping.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateEventSourceMappingRequest
```
public UpdateEventSourceMappingRequest()
```
- Method Detail
  - setUUID
```
public void setUUID(String uUID)
```
    The identifier of the event source mapping.
    
    Parameters:
    
    uUID - The identifier of the event source mapping.
  - getUUID
```
public String getUUID()
```
    The identifier of the event source mapping.
    
    Returns:
    
    The identifier of the event source mapping.
  - withUUID
```
public UpdateEventSourceMappingRequest withUUID(String 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.
  - setFunctionName
```
public void setFunctionName(String 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.
  - getFunctionName
```
public String getFunctionName()
```
    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:
    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.
  - withFunctionName
```
public UpdateEventSourceMappingRequest withFunctionName(String 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.
  - setEnabled
```
public void setEnabled(Boolean 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
  - getEnabled
```
public Boolean getEnabled()
```
    When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
    
    Default: True
    
    Returns:
    
    When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
    
    Default: True
  - withEnabled
```
public UpdateEventSourceMappingRequest withEnabled(Boolean 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.
  - isEnabled
```
public Boolean isEnabled()
```
    When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
    
    Default: True
    
    Returns:
    
    When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
    
    Default: True
  - setBatchSize
```
public void setBatchSize(Integer 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.
  - getBatchSize
```
public Integer getBatchSize()
```
    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:
    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.
  - withBatchSize
```
public UpdateEventSourceMappingRequest withBatchSize(Integer 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.
  - setFilterCriteria
```
public void setFilterCriteria(FilterCriteria 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.
  - getFilterCriteria
```
public FilterCriteria getFilterCriteria()
```
    An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
    
    Returns:
    
    An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
  - withFilterCriteria
```
public UpdateEventSourceMappingRequest withFilterCriteria(FilterCriteria 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.
  - setMaximumBatchingWindowInSeconds
```
public void setMaximumBatchingWindowInSeconds(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 set MaximumBatchingWindowInSeconds to at least 1.
    
    Parameters:
    
    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 set MaximumBatchingWindowInSeconds to at least 1.
  - getMaximumBatchingWindowInSeconds
```
public Integer getMaximumBatchingWindowInSeconds()
```
    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 set MaximumBatchingWindowInSeconds to at least 1.
    
    Returns:
    
    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 set MaximumBatchingWindowInSeconds to at least 1.
  - withMaximumBatchingWindowInSeconds
```
public UpdateEventSourceMappingRequest withMaximumBatchingWindowInSeconds(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 set MaximumBatchingWindowInSeconds to at least 1.
    
    Parameters:
    
    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 set MaximumBatchingWindowInSeconds to at least 1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestinationConfig
```
public void setDestinationConfig(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.
    
    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.
  - getDestinationConfig
```
public DestinationConfig getDestinationConfig()
```
    (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:
    
    (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.
  - withDestinationConfig
```
public UpdateEventSourceMappingRequest withDestinationConfig(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.
    
    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.
  - setMaximumRecordAgeInSeconds
```
public void setMaximumRecordAgeInSeconds(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).
  - getMaximumRecordAgeInSeconds
```
public Integer getMaximumRecordAgeInSeconds()
```
    (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).
    
    Returns:
    
    (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).
  - withMaximumRecordAgeInSeconds
```
public UpdateEventSourceMappingRequest withMaximumRecordAgeInSeconds(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.
  - setBisectBatchOnFunctionError
```
public void setBisectBatchOnFunctionError(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.
  - getBisectBatchOnFunctionError
```
public Boolean getBisectBatchOnFunctionError()
```
    (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
    
    Returns:
    
    (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
  - withBisectBatchOnFunctionError
```
public UpdateEventSourceMappingRequest withBisectBatchOnFunctionError(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.
  - isBisectBatchOnFunctionError
```
public Boolean isBisectBatchOnFunctionError()
```
    (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
    
    Returns:
    
    (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
  - setMaximumRetryAttempts
```
public void setMaximumRetryAttempts(Integer 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.
  - getMaximumRetryAttempts
```
public Integer getMaximumRetryAttempts()
```
    (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:
    
    (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.
  - withMaximumRetryAttempts
```
public UpdateEventSourceMappingRequest withMaximumRetryAttempts(Integer 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.
  - setParallelizationFactor
```
public void setParallelizationFactor(Integer 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.
  - getParallelizationFactor
```
public Integer getParallelizationFactor()
```
    (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
    
    Returns:
    
    (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
  - withParallelizationFactor
```
public UpdateEventSourceMappingRequest withParallelizationFactor(Integer 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.
  - getSourceAccessConfigurations
```
public List<SourceAccessConfiguration> getSourceAccessConfigurations()
```
    An array of authentication protocols or VPC components required to secure your event source.
    
    Returns:
    
    An array of authentication protocols or VPC components required to secure your event source.
  - setSourceAccessConfigurations
```
public void setSourceAccessConfigurations(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.
  - withSourceAccessConfigurations
```
public UpdateEventSourceMappingRequest withSourceAccessConfigurations(SourceAccessConfiguration... sourceAccessConfigurations)
```
    An array of authentication protocols or VPC components required to secure your event source.
    
    NOTE: This method appends the values to the existing list (if any). Use setSourceAccessConfigurations(java.util.Collection) or withSourceAccessConfigurations(java.util.Collection) if you want to override the existing values.
    
    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.
  - withSourceAccessConfigurations
```
public UpdateEventSourceMappingRequest withSourceAccessConfigurations(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.
  - setTumblingWindowInSeconds
```
public void setTumblingWindowInSeconds(Integer 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.
  - getTumblingWindowInSeconds
```
public Integer getTumblingWindowInSeconds()
```
    (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:
    
    (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.
  - withTumblingWindowInSeconds
```
public UpdateEventSourceMappingRequest withTumblingWindowInSeconds(Integer 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.
  - getFunctionResponseTypes
```
public List<String> getFunctionResponseTypes()
```
    (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
    
    Returns:
    
    (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
    
    See Also:
    
    FunctionResponseType
  - setFunctionResponseTypes
```
public void setFunctionResponseTypes(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.
    
    See Also:
    
    FunctionResponseType
  - withFunctionResponseTypes
```
public UpdateEventSourceMappingRequest withFunctionResponseTypes(String... functionResponseTypes)
```
    (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
    
    NOTE: This method appends the values to the existing list (if any). Use setFunctionResponseTypes(java.util.Collection) or withFunctionResponseTypes(java.util.Collection) if you want to override the existing values.
    
    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.
    
    See Also:
    
    FunctionResponseType
  - withFunctionResponseTypes
```
public UpdateEventSourceMappingRequest withFunctionResponseTypes(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.
    
    See Also:
    
    FunctionResponseType
  - withFunctionResponseTypes
```
public UpdateEventSourceMappingRequest withFunctionResponseTypes(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.
    
    See Also:
    
    FunctionResponseType
  - setScalingConfig
```
public void setScalingConfig(ScalingConfig 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.
  - getScalingConfig
```
public ScalingConfig getScalingConfig()
```
    (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
    
    Returns:
    
    (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
  - withScalingConfig
```
public UpdateEventSourceMappingRequest withScalingConfig(ScalingConfig 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.
  - setDocumentDBEventSourceConfig
```
public void setDocumentDBEventSourceConfig(DocumentDBEventSourceConfig documentDBEventSourceConfig)
```
    Specific configuration settings for a DocumentDB event source.
    
    Parameters:
    
    documentDBEventSourceConfig - Specific configuration settings for a DocumentDB event source.
  - getDocumentDBEventSourceConfig
```
public DocumentDBEventSourceConfig getDocumentDBEventSourceConfig()
```
    Specific configuration settings for a DocumentDB event source.
    
    Returns:
    
    Specific configuration settings for a DocumentDB event source.
  - withDocumentDBEventSourceConfig
```
public UpdateEventSourceMappingRequest withDocumentDBEventSourceConfig(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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UpdateEventSourceMappingRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class UpdateEventSourceMappingRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateEventSourceMappingRequest

Method Detail

setUUID

getUUID

withUUID

setFunctionName

getFunctionName

withFunctionName

setEnabled

getEnabled

withEnabled

isEnabled

setBatchSize

getBatchSize

withBatchSize

setFilterCriteria

getFilterCriteria

withFilterCriteria

setMaximumBatchingWindowInSeconds

getMaximumBatchingWindowInSeconds

withMaximumBatchingWindowInSeconds

setDestinationConfig

getDestinationConfig

withDestinationConfig

setMaximumRecordAgeInSeconds

getMaximumRecordAgeInSeconds

withMaximumRecordAgeInSeconds

setBisectBatchOnFunctionError

getBisectBatchOnFunctionError

withBisectBatchOnFunctionError

isBisectBatchOnFunctionError

setMaximumRetryAttempts

getMaximumRetryAttempts

withMaximumRetryAttempts

setParallelizationFactor

getParallelizationFactor

withParallelizationFactor

getSourceAccessConfigurations

setSourceAccessConfigurations

withSourceAccessConfigurations

withSourceAccessConfigurations

setTumblingWindowInSeconds

getTumblingWindowInSeconds

withTumblingWindowInSeconds

getFunctionResponseTypes

setFunctionResponseTypes

withFunctionResponseTypes

withFunctionResponseTypes

withFunctionResponseTypes

setScalingConfig

getScalingConfig

withScalingConfig

setDocumentDBEventSourceConfig

getDocumentDBEventSourceConfig

withDocumentDBEventSourceConfig

toString

equals

hashCode

clone