@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateEventSourceMappingRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateEventSourceMappingRequest() |
Modifier and Type | Method and Description |
---|---|
CreateEventSourceMappingRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
AmazonManagedKafkaEventSourceConfig |
getAmazonManagedKafkaEventSourceConfig()
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
|
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.
|
String |
getEventSourceArn()
The Amazon Resource Name (ARN) of the event source.
|
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.
|
List<String> |
getQueues()
(MQ) The name of the Amazon MQ broker destination queue to consume.
|
ScalingConfig |
getScalingConfig()
(Amazon SQS only) The scaling configuration for the event source.
|
SelfManagedEventSource |
getSelfManagedEventSource()
The self-managed Apache Kafka cluster to receive records from.
|
SelfManagedKafkaEventSourceConfig |
getSelfManagedKafkaEventSourceConfig()
Specific configuration settings for a self-managed Apache Kafka event source.
|
List<SourceAccessConfiguration> |
getSourceAccessConfigurations()
An array of authentication protocols or VPC components required to secure your event source.
|
String |
getStartingPosition()
The position in a stream from which to start reading.
|
Date |
getStartingPositionTimestamp()
With
StartingPosition set to AT_TIMESTAMP , the time from which to start reading. |
List<String> |
getTopics()
The name of the Kafka topic.
|
Integer |
getTumblingWindowInSeconds()
(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis
Streams event sources.
|
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 |
setAmazonManagedKafkaEventSourceConfig(AmazonManagedKafkaEventSourceConfig amazonManagedKafkaEventSourceConfig)
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
|
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 |
setEventSourceArn(String eventSourceArn)
The Amazon Resource Name (ARN) of the event source.
|
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 |
setQueues(Collection<String> queues)
(MQ) The name of the Amazon MQ broker destination queue to consume.
|
void |
setScalingConfig(ScalingConfig scalingConfig)
(Amazon SQS only) The scaling configuration for the event source.
|
void |
setSelfManagedEventSource(SelfManagedEventSource selfManagedEventSource)
The self-managed Apache Kafka cluster to receive records from.
|
void |
setSelfManagedKafkaEventSourceConfig(SelfManagedKafkaEventSourceConfig selfManagedKafkaEventSourceConfig)
Specific configuration settings for a self-managed Apache Kafka event source.
|
void |
setSourceAccessConfigurations(Collection<SourceAccessConfiguration> sourceAccessConfigurations)
An array of authentication protocols or VPC components required to secure your event source.
|
void |
setStartingPosition(EventSourcePosition startingPosition)
The position in a stream from which to start reading.
|
void |
setStartingPosition(String startingPosition)
The position in a stream from which to start reading.
|
void |
setStartingPositionTimestamp(Date startingPositionTimestamp)
With
StartingPosition set to AT_TIMESTAMP , the time from which to start reading. |
void |
setTopics(Collection<String> topics)
The name of the Kafka topic.
|
void |
setTumblingWindowInSeconds(Integer tumblingWindowInSeconds)
(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis
Streams event sources.
|
String |
toString()
Returns a string representation of this object.
|
CreateEventSourceMappingRequest |
withAmazonManagedKafkaEventSourceConfig(AmazonManagedKafkaEventSourceConfig amazonManagedKafkaEventSourceConfig)
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
|
CreateEventSourceMappingRequest |
withBatchSize(Integer batchSize)
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your
function.
|
CreateEventSourceMappingRequest |
withBisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)
(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
|
CreateEventSourceMappingRequest |
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.
|
CreateEventSourceMappingRequest |
withDocumentDBEventSourceConfig(DocumentDBEventSourceConfig documentDBEventSourceConfig)
Specific configuration settings for a DocumentDB event source.
|
CreateEventSourceMappingRequest |
withEnabled(Boolean enabled)
When true, the event source mapping is active.
|
CreateEventSourceMappingRequest |
withEventSourceArn(String eventSourceArn)
The Amazon Resource Name (ARN) of the event source.
|
CreateEventSourceMappingRequest |
withFilterCriteria(FilterCriteria filterCriteria)
An object that defines the filter criteria that determine whether Lambda should process an event.
|
CreateEventSourceMappingRequest |
withFunctionName(String functionName)
The name or ARN of the Lambda function.
|
CreateEventSourceMappingRequest |
withFunctionResponseTypes(Collection<String> functionResponseTypes)
(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source
mapping.
|
CreateEventSourceMappingRequest |
withFunctionResponseTypes(FunctionResponseType... functionResponseTypes)
(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source
mapping.
|
CreateEventSourceMappingRequest |
withFunctionResponseTypes(String... functionResponseTypes)
(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source
mapping.
|
CreateEventSourceMappingRequest |
withMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
|
CreateEventSourceMappingRequest |
withMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)
(Kinesis and DynamoDB Streams only) Discard records older than the specified age.
|
CreateEventSourceMappingRequest |
withMaximumRetryAttempts(Integer maximumRetryAttempts)
(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.
|
CreateEventSourceMappingRequest |
withParallelizationFactor(Integer parallelizationFactor)
(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
|
CreateEventSourceMappingRequest |
withQueues(Collection<String> queues)
(MQ) The name of the Amazon MQ broker destination queue to consume.
|
CreateEventSourceMappingRequest |
withQueues(String... queues)
(MQ) The name of the Amazon MQ broker destination queue to consume.
|
CreateEventSourceMappingRequest |
withScalingConfig(ScalingConfig scalingConfig)
(Amazon SQS only) The scaling configuration for the event source.
|
CreateEventSourceMappingRequest |
withSelfManagedEventSource(SelfManagedEventSource selfManagedEventSource)
The self-managed Apache Kafka cluster to receive records from.
|
CreateEventSourceMappingRequest |
withSelfManagedKafkaEventSourceConfig(SelfManagedKafkaEventSourceConfig selfManagedKafkaEventSourceConfig)
Specific configuration settings for a self-managed Apache Kafka event source.
|
CreateEventSourceMappingRequest |
withSourceAccessConfigurations(Collection<SourceAccessConfiguration> sourceAccessConfigurations)
An array of authentication protocols or VPC components required to secure your event source.
|
CreateEventSourceMappingRequest |
withSourceAccessConfigurations(SourceAccessConfiguration... sourceAccessConfigurations)
An array of authentication protocols or VPC components required to secure your event source.
|
CreateEventSourceMappingRequest |
withStartingPosition(EventSourcePosition startingPosition)
The position in a stream from which to start reading.
|
CreateEventSourceMappingRequest |
withStartingPosition(String startingPosition)
The position in a stream from which to start reading.
|
CreateEventSourceMappingRequest |
withStartingPositionTimestamp(Date startingPositionTimestamp)
With
StartingPosition set to AT_TIMESTAMP , the time from which to start reading. |
CreateEventSourceMappingRequest |
withTopics(Collection<String> topics)
The name of the Kafka topic.
|
CreateEventSourceMappingRequest |
withTopics(String... topics)
The name of the Kafka topic.
|
CreateEventSourceMappingRequest |
withTumblingWindowInSeconds(Integer tumblingWindowInSeconds)
(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis
Streams event sources.
|
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
public void setEventSourceArn(String eventSourceArn)
The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis – The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams – The ARN of the stream.
Amazon Simple Queue Service – The ARN of the queue.
Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).
Amazon MQ – The ARN of the broker.
Amazon DocumentDB – The ARN of the DocumentDB change stream.
eventSourceArn
- The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis – The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams – The ARN of the stream.
Amazon Simple Queue Service – The ARN of the queue.
Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).
Amazon MQ – The ARN of the broker.
Amazon DocumentDB – The ARN of the DocumentDB change stream.
public String getEventSourceArn()
The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis – The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams – The ARN of the stream.
Amazon Simple Queue Service – The ARN of the queue.
Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).
Amazon MQ – The ARN of the broker.
Amazon DocumentDB – The ARN of the DocumentDB change stream.
Amazon Kinesis – The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams – The ARN of the stream.
Amazon Simple Queue Service – The ARN of the queue.
Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).
Amazon MQ – The ARN of the broker.
Amazon DocumentDB – The ARN of the DocumentDB change stream.
public CreateEventSourceMappingRequest withEventSourceArn(String eventSourceArn)
The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis – The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams – The ARN of the stream.
Amazon Simple Queue Service – The ARN of the queue.
Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).
Amazon MQ – The ARN of the broker.
Amazon DocumentDB – The ARN of the DocumentDB change stream.
eventSourceArn
- The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis – The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams – The ARN of the stream.
Amazon Simple Queue Service – The ARN of the queue.
Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).
Amazon MQ – The ARN of the broker.
Amazon DocumentDB – The ARN of the DocumentDB change stream.
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.
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.
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.
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.
public CreateEventSourceMappingRequest 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.
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.
public void setEnabled(Boolean enabled)
When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
enabled
- When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
public Boolean getEnabled()
When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
Default: True
public CreateEventSourceMappingRequest withEnabled(Boolean enabled)
When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
enabled
- When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
public Boolean isEnabled()
When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
Default: True
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.
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.
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.
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.
public CreateEventSourceMappingRequest 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.
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.
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.
filterCriteria
- An object that defines the filter criteria that determine whether Lambda should process an event. For more
information, see Lambda event
filtering.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.
public CreateEventSourceMappingRequest 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.
filterCriteria
- An object that defines the filter criteria that determine whether Lambda should process an event. For more
information, see Lambda event
filtering.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.
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.
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.
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.
public CreateEventSourceMappingRequest 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.
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.
public void setParallelizationFactor(Integer parallelizationFactor)
(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
parallelizationFactor
- (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.public Integer getParallelizationFactor()
(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
public CreateEventSourceMappingRequest withParallelizationFactor(Integer parallelizationFactor)
(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
parallelizationFactor
- (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.public void setStartingPosition(String startingPosition)
The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream
event sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon
MSK, and self-managed Apache Kafka.
startingPosition
- The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB
Stream event sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon
DocumentDB, Amazon MSK, and self-managed Apache Kafka.EventSourcePosition
public String getStartingPosition()
The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream
event sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon
MSK, and self-managed Apache Kafka.
AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon
DocumentDB, Amazon MSK, and self-managed Apache Kafka.EventSourcePosition
public CreateEventSourceMappingRequest withStartingPosition(String startingPosition)
The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream
event sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon
MSK, and self-managed Apache Kafka.
startingPosition
- The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB
Stream event sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon
DocumentDB, Amazon MSK, and self-managed Apache Kafka.EventSourcePosition
public void setStartingPosition(EventSourcePosition startingPosition)
The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream
event sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon
MSK, and self-managed Apache Kafka.
startingPosition
- The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB
Stream event sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon
DocumentDB, Amazon MSK, and self-managed Apache Kafka.EventSourcePosition
public CreateEventSourceMappingRequest withStartingPosition(EventSourcePosition startingPosition)
The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream
event sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon
MSK, and self-managed Apache Kafka.
startingPosition
- The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB
Stream event sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon
DocumentDB, Amazon MSK, and self-managed Apache Kafka.EventSourcePosition
public void setStartingPositionTimestamp(Date startingPositionTimestamp)
With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
StartingPositionTimestamp
cannot be in the future.
startingPositionTimestamp
- With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
StartingPositionTimestamp
cannot be in the future.public Date getStartingPositionTimestamp()
With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
StartingPositionTimestamp
cannot be in the future.
StartingPosition
set to AT_TIMESTAMP
, the time from which to start
reading. StartingPositionTimestamp
cannot be in the future.public CreateEventSourceMappingRequest withStartingPositionTimestamp(Date startingPositionTimestamp)
With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
StartingPositionTimestamp
cannot be in the future.
startingPositionTimestamp
- With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
StartingPositionTimestamp
cannot be in the future.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.
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.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.
public CreateEventSourceMappingRequest 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.
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.public void setMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)
(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).
maximumRecordAgeInSeconds
- (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is
infinite (-1).public Integer getMaximumRecordAgeInSeconds()
(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).
public CreateEventSourceMappingRequest withMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)
(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).
maximumRecordAgeInSeconds
- (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is
infinite (-1).public void setBisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)
(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
bisectBatchOnFunctionError
- (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.public Boolean getBisectBatchOnFunctionError()
(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
public CreateEventSourceMappingRequest withBisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)
(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
bisectBatchOnFunctionError
- (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.public Boolean isBisectBatchOnFunctionError()
(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
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.
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.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.
public CreateEventSourceMappingRequest 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.
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.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.
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.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.
public CreateEventSourceMappingRequest 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.
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.public List<String> getTopics()
The name of the Kafka topic.
public void setTopics(Collection<String> topics)
The name of the Kafka topic.
topics
- The name of the Kafka topic.public CreateEventSourceMappingRequest withTopics(String... topics)
The name of the Kafka topic.
NOTE: This method appends the values to the existing list (if any). Use
setTopics(java.util.Collection)
or withTopics(java.util.Collection)
if you want to override the
existing values.
topics
- The name of the Kafka topic.public CreateEventSourceMappingRequest withTopics(Collection<String> topics)
The name of the Kafka topic.
topics
- The name of the Kafka topic.public List<String> getQueues()
(MQ) The name of the Amazon MQ broker destination queue to consume.
public void setQueues(Collection<String> queues)
(MQ) The name of the Amazon MQ broker destination queue to consume.
queues
- (MQ) The name of the Amazon MQ broker destination queue to consume.public CreateEventSourceMappingRequest withQueues(String... queues)
(MQ) The name of the Amazon MQ broker destination queue to consume.
NOTE: This method appends the values to the existing list (if any). Use
setQueues(java.util.Collection)
or withQueues(java.util.Collection)
if you want to override the
existing values.
queues
- (MQ) The name of the Amazon MQ broker destination queue to consume.public CreateEventSourceMappingRequest withQueues(Collection<String> queues)
(MQ) The name of the Amazon MQ broker destination queue to consume.
queues
- (MQ) The name of the Amazon MQ broker destination queue to consume.public List<SourceAccessConfiguration> getSourceAccessConfigurations()
An array of authentication protocols or VPC components required to secure your event source.
public void setSourceAccessConfigurations(Collection<SourceAccessConfiguration> sourceAccessConfigurations)
An array of authentication protocols or VPC components required to secure your event source.
sourceAccessConfigurations
- An array of authentication protocols or VPC components required to secure your event source.public CreateEventSourceMappingRequest 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.
sourceAccessConfigurations
- An array of authentication protocols or VPC components required to secure your event source.public CreateEventSourceMappingRequest withSourceAccessConfigurations(Collection<SourceAccessConfiguration> sourceAccessConfigurations)
An array of authentication protocols or VPC components required to secure your event source.
sourceAccessConfigurations
- An array of authentication protocols or VPC components required to secure your event source.public void setSelfManagedEventSource(SelfManagedEventSource selfManagedEventSource)
The self-managed Apache Kafka cluster to receive records from.
selfManagedEventSource
- The self-managed Apache Kafka cluster to receive records from.public SelfManagedEventSource getSelfManagedEventSource()
The self-managed Apache Kafka cluster to receive records from.
public CreateEventSourceMappingRequest withSelfManagedEventSource(SelfManagedEventSource selfManagedEventSource)
The self-managed Apache Kafka cluster to receive records from.
selfManagedEventSource
- The self-managed Apache Kafka cluster to receive records from.public List<String> getFunctionResponseTypes()
(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
FunctionResponseType
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.
functionResponseTypes
- (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event
source mapping.FunctionResponseType
public CreateEventSourceMappingRequest 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.
functionResponseTypes
- (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event
source mapping.FunctionResponseType
public CreateEventSourceMappingRequest withFunctionResponseTypes(Collection<String> functionResponseTypes)
(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
functionResponseTypes
- (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event
source mapping.FunctionResponseType
public CreateEventSourceMappingRequest withFunctionResponseTypes(FunctionResponseType... functionResponseTypes)
(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
functionResponseTypes
- (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event
source mapping.FunctionResponseType
public void setAmazonManagedKafkaEventSourceConfig(AmazonManagedKafkaEventSourceConfig amazonManagedKafkaEventSourceConfig)
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
amazonManagedKafkaEventSourceConfig
- Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event
source.public AmazonManagedKafkaEventSourceConfig getAmazonManagedKafkaEventSourceConfig()
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
public CreateEventSourceMappingRequest withAmazonManagedKafkaEventSourceConfig(AmazonManagedKafkaEventSourceConfig amazonManagedKafkaEventSourceConfig)
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
amazonManagedKafkaEventSourceConfig
- Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event
source.public void setSelfManagedKafkaEventSourceConfig(SelfManagedKafkaEventSourceConfig selfManagedKafkaEventSourceConfig)
Specific configuration settings for a self-managed Apache Kafka event source.
selfManagedKafkaEventSourceConfig
- Specific configuration settings for a self-managed Apache Kafka event source.public SelfManagedKafkaEventSourceConfig getSelfManagedKafkaEventSourceConfig()
Specific configuration settings for a self-managed Apache Kafka event source.
public CreateEventSourceMappingRequest withSelfManagedKafkaEventSourceConfig(SelfManagedKafkaEventSourceConfig selfManagedKafkaEventSourceConfig)
Specific configuration settings for a self-managed Apache Kafka event source.
selfManagedKafkaEventSourceConfig
- Specific configuration settings for a self-managed Apache Kafka event source.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.
scalingConfig
- (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring
maximum concurrency for Amazon SQS event sources.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.
public CreateEventSourceMappingRequest 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.
scalingConfig
- (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring
maximum concurrency for Amazon SQS event sources.public void setDocumentDBEventSourceConfig(DocumentDBEventSourceConfig documentDBEventSourceConfig)
Specific configuration settings for a DocumentDB event source.
documentDBEventSourceConfig
- Specific configuration settings for a DocumentDB event source.public DocumentDBEventSourceConfig getDocumentDBEventSourceConfig()
Specific configuration settings for a DocumentDB event source.
public CreateEventSourceMappingRequest withDocumentDBEventSourceConfig(DocumentDBEventSourceConfig documentDBEventSourceConfig)
Specific configuration settings for a DocumentDB event source.
documentDBEventSourceConfig
- Specific configuration settings for a DocumentDB event source.public String toString()
toString
in class Object
Object.toString()
public CreateEventSourceMappingRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()