CreateEventSourceMappingRequest (AWS SDK for Java

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

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

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateEventSourceMappingRequest
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

CreateEventSourceMappingRequest()

Constructors
Constructor and Description
`CreateEventSourceMappingRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
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)`
`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()` (Streams only) If the function returns an error, split the batch in two and retry.
`DestinationConfig`	`getDestinationConfig()` (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
`Boolean`	`getEnabled()` When true, the event source mapping is active.
`String`	`getEventSourceArn()` The Amazon Resource Name (ARN) of the event source.
`FilterCriteria`	`getFilterCriteria()` (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event.
`String`	`getFunctionName()` The name of the Lambda function.
`List<String>`	`getFunctionResponseTypes()` (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
`Integer`	`getMaximumBatchingWindowInSeconds()` (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
`Integer`	`getMaximumRecordAgeInSeconds()` (Streams only) Discard records older than the specified age.
`Integer`	`getMaximumRetryAttempts()` (Streams only) Discard records after the specified number of retries.
`Integer`	`getParallelizationFactor()` (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.
`SelfManagedEventSource`	`getSelfManagedEventSource()` The Self-Managed Apache Kafka cluster to send records.
`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()` (Streams only) The duration in seconds of a processing window.
`int`	`hashCode()`
`Boolean`	`isBisectBatchOnFunctionError()` (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)` (Streams only) If the function returns an error, split the batch in two and retry.
`void`	`setDestinationConfig(DestinationConfig destinationConfig)` (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
`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)` (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event.
`void`	`setFunctionName(String functionName)` The name of the Lambda function.
`void`	`setFunctionResponseTypes(Collection<String> functionResponseTypes)` (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
`void`	`setMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)` (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
`void`	`setMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)` (Streams only) Discard records older than the specified age.
`void`	`setMaximumRetryAttempts(Integer maximumRetryAttempts)` (Streams only) Discard records after the specified number of retries.
`void`	`setParallelizationFactor(Integer parallelizationFactor)` (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`	`setSelfManagedEventSource(SelfManagedEventSource selfManagedEventSource)` The Self-Managed Apache Kafka cluster to send records.
`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)` (Streams only) The duration in seconds of a processing window.
`String`	`toString()` Returns a string representation of this object.
`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)` (Streams only) If the function returns an error, split the batch in two and retry.
`CreateEventSourceMappingRequest`	`withDestinationConfig(DestinationConfig destinationConfig)` (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
`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)` (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event.
`CreateEventSourceMappingRequest`	`withFunctionName(String functionName)` The name of the Lambda function.
`CreateEventSourceMappingRequest`	`withFunctionResponseTypes(Collection<String> functionResponseTypes)` (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
`CreateEventSourceMappingRequest`	`withFunctionResponseTypes(FunctionResponseType... functionResponseTypes)` (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
`CreateEventSourceMappingRequest`	`withFunctionResponseTypes(String... functionResponseTypes)` (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
`CreateEventSourceMappingRequest`	`withMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)` (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
`CreateEventSourceMappingRequest`	`withMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)` (Streams only) Discard records older than the specified age.
`CreateEventSourceMappingRequest`	`withMaximumRetryAttempts(Integer maximumRetryAttempts)` (Streams only) Discard records after the specified number of retries.
`CreateEventSourceMappingRequest`	`withParallelizationFactor(Integer parallelizationFactor)` (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`	`withSelfManagedEventSource(SelfManagedEventSource selfManagedEventSource)` The Self-Managed Apache Kafka cluster to send records.
`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)` (Streams only) The duration in seconds of a processing window.

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

- Constructor Detail
  - CreateEventSourceMappingRequest
```
public CreateEventSourceMappingRequest()
```
- Method Detail
  - setEventSourceArn
```
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.
    Parameters:
    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.
  - getEventSourceArn
```
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.
    Returns:
    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.
  - withEventSourceArn
```
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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFunctionName
```
public void setFunctionName(String functionName)
```
    The name 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 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 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 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 CreateEventSourceMappingRequest withFunctionName(String functionName)
```
    The name 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 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 CreateEventSourceMappingRequest 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.
    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.
  - 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.
    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.
  - withBatchSize
```
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.
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFilterCriteria
```
public void setFilterCriteria(FilterCriteria filterCriteria)
```
    (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
    
    Parameters:
    
    filterCriteria - (Streams and Amazon SQS) 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()
```
    (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
    
    Returns:
    
    (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
  - withFilterCriteria
```
public CreateEventSourceMappingRequest withFilterCriteria(FilterCriteria filterCriteria)
```
    (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
    
    Parameters:
    
    filterCriteria - (Streams and Amazon SQS) 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)
```
    (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
    
    Default: 0
    
    Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
    
    Parameters:
    
    maximumBatchingWindowInSeconds - (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
    
    Default: 0
    
    Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
  - getMaximumBatchingWindowInSeconds
```
public Integer getMaximumBatchingWindowInSeconds()
```
    (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
    
    Default: 0
    
    Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
    
    Returns:
    
    (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
    
    Default: 0
    
    Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
  - withMaximumBatchingWindowInSeconds
```
public CreateEventSourceMappingRequest withMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)
```
    (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
    
    Default: 0
    
    Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
    
    Parameters:
    
    maximumBatchingWindowInSeconds - (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
    
    Default: 0
    
    Related setting: 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.
  - setParallelizationFactor
```
public void setParallelizationFactor(Integer parallelizationFactor)
```
    (Streams only) The number of batches to process from each shard concurrently.
    
    Parameters:
    
    parallelizationFactor - (Streams only) The number of batches to process from each shard concurrently.
  - getParallelizationFactor
```
public Integer getParallelizationFactor()
```
    (Streams only) The number of batches to process from each shard concurrently.
    
    Returns:
    
    (Streams only) The number of batches to process from each shard concurrently.
  - withParallelizationFactor
```
public CreateEventSourceMappingRequest withParallelizationFactor(Integer parallelizationFactor)
```
    (Streams only) The number of batches to process from each shard concurrently.
    
    Parameters:
    
    parallelizationFactor - (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.
  - setStartingPosition
```
public void setStartingPosition(String startingPosition)
```
    The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
    
    Parameters:
    
    startingPosition - The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
    
    See Also:
    
    EventSourcePosition
  - getStartingPosition
```
public String getStartingPosition()
```
    The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
    
    Returns:
    
    The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
    
    See Also:
    
    EventSourcePosition
  - withStartingPosition
```
public CreateEventSourceMappingRequest withStartingPosition(String startingPosition)
```
    The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
    
    Parameters:
    
    startingPosition - The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EventSourcePosition
  - setStartingPosition
```
public void setStartingPosition(EventSourcePosition startingPosition)
```
    The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
    
    Parameters:
    
    startingPosition - The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
    
    See Also:
    
    EventSourcePosition
  - withStartingPosition
```
public CreateEventSourceMappingRequest withStartingPosition(EventSourcePosition startingPosition)
```
    The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
    
    Parameters:
    
    startingPosition - The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EventSourcePosition
  - setStartingPositionTimestamp
```
public void setStartingPositionTimestamp(Date startingPositionTimestamp)
```
    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
    
    Parameters:
    
    startingPositionTimestamp - With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
  - getStartingPositionTimestamp
```
public Date getStartingPositionTimestamp()
```
    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
    
    Returns:
    
    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
  - withStartingPositionTimestamp
```
public CreateEventSourceMappingRequest withStartingPositionTimestamp(Date startingPositionTimestamp)
```
    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
    
    Parameters:
    
    startingPositionTimestamp - With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestinationConfig
```
public void setDestinationConfig(DestinationConfig destinationConfig)
```
    (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    
    Parameters:
    
    destinationConfig - (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
  - getDestinationConfig
```
public DestinationConfig getDestinationConfig()
```
    (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    
    Returns:
    
    (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
  - withDestinationConfig
```
public CreateEventSourceMappingRequest withDestinationConfig(DestinationConfig destinationConfig)
```
    (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    
    Parameters:
    
    destinationConfig - (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaximumRecordAgeInSeconds
```
public void setMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)
```
    (Streams only) Discard records older than the specified age. The default value is infinite (-1).
    
    Parameters:
    
    maximumRecordAgeInSeconds - (Streams only) Discard records older than the specified age. The default value is infinite (-1).
  - getMaximumRecordAgeInSeconds
```
public Integer getMaximumRecordAgeInSeconds()
```
    (Streams only) Discard records older than the specified age. The default value is infinite (-1).
    
    Returns:
    
    (Streams only) Discard records older than the specified age. The default value is infinite (-1).
  - withMaximumRecordAgeInSeconds
```
public CreateEventSourceMappingRequest withMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)
```
    (Streams only) Discard records older than the specified age. The default value is infinite (-1).
    
    Parameters:
    
    maximumRecordAgeInSeconds - (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)
```
    (Streams only) If the function returns an error, split the batch in two and retry.
    
    Parameters:
    
    bisectBatchOnFunctionError - (Streams only) If the function returns an error, split the batch in two and retry.
  - getBisectBatchOnFunctionError
```
public Boolean getBisectBatchOnFunctionError()
```
    (Streams only) If the function returns an error, split the batch in two and retry.
    
    Returns:
    
    (Streams only) If the function returns an error, split the batch in two and retry.
  - withBisectBatchOnFunctionError
```
public CreateEventSourceMappingRequest withBisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)
```
    (Streams only) If the function returns an error, split the batch in two and retry.
    
    Parameters:
    
    bisectBatchOnFunctionError - (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()
```
    (Streams only) If the function returns an error, split the batch in two and retry.
    
    Returns:
    
    (Streams only) If the function returns an error, split the batch in two and retry.
  - setMaximumRetryAttempts
```
public void setMaximumRetryAttempts(Integer maximumRetryAttempts)
```
    (Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
    
    Parameters:
    
    maximumRetryAttempts - (Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
  - getMaximumRetryAttempts
```
public Integer getMaximumRetryAttempts()
```
    (Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
    
    Returns:
    
    (Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
  - withMaximumRetryAttempts
```
public CreateEventSourceMappingRequest withMaximumRetryAttempts(Integer maximumRetryAttempts)
```
    (Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
    
    Parameters:
    
    maximumRetryAttempts - (Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTumblingWindowInSeconds
```
public void setTumblingWindowInSeconds(Integer tumblingWindowInSeconds)
```
    (Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
    
    Parameters:
    
    tumblingWindowInSeconds - (Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
  - getTumblingWindowInSeconds
```
public Integer getTumblingWindowInSeconds()
```
    (Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
    
    Returns:
    
    (Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
  - withTumblingWindowInSeconds
```
public CreateEventSourceMappingRequest withTumblingWindowInSeconds(Integer tumblingWindowInSeconds)
```
    (Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
    
    Parameters:
    
    tumblingWindowInSeconds - (Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTopics
```
public List<String> getTopics()
```
    The name of the Kafka topic.
    
    Returns:
    
    The name of the Kafka topic.
  - setTopics
```
public void setTopics(Collection<String> topics)
```
    The name of the Kafka topic.
    
    Parameters:
    
    topics - The name of the Kafka topic.
  - withTopics
```
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.
    
    Parameters:
    
    topics - The name of the Kafka topic.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTopics
```
public CreateEventSourceMappingRequest withTopics(Collection<String> topics)
```
    The name of the Kafka topic.
    
    Parameters:
    
    topics - The name of the Kafka topic.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getQueues
```
public List<String> getQueues()
```
    (MQ) The name of the Amazon MQ broker destination queue to consume.
    
    Returns:
    
    (MQ) The name of the Amazon MQ broker destination queue to consume.
  - setQueues
```
public void setQueues(Collection<String> queues)
```
    (MQ) The name of the Amazon MQ broker destination queue to consume.
    
    Parameters:
    
    queues - (MQ) The name of the Amazon MQ broker destination queue to consume.
  - withQueues
```
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.
    
    Parameters:
    
    queues - (MQ) The name of the Amazon MQ broker destination queue to consume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withQueues
```
public CreateEventSourceMappingRequest withQueues(Collection<String> queues)
```
    (MQ) The name of the Amazon MQ broker destination queue to consume.
    
    Parameters:
    
    queues - (MQ) The name of the Amazon MQ broker destination queue to consume.
    
    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 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.
    
    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 CreateEventSourceMappingRequest 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.
  - setSelfManagedEventSource
```
public void setSelfManagedEventSource(SelfManagedEventSource selfManagedEventSource)
```
    The Self-Managed Apache Kafka cluster to send records.
    
    Parameters:
    
    selfManagedEventSource - The Self-Managed Apache Kafka cluster to send records.
  - getSelfManagedEventSource
```
public SelfManagedEventSource getSelfManagedEventSource()
```
    The Self-Managed Apache Kafka cluster to send records.
    
    Returns:
    
    The Self-Managed Apache Kafka cluster to send records.
  - withSelfManagedEventSource
```
public CreateEventSourceMappingRequest withSelfManagedEventSource(SelfManagedEventSource selfManagedEventSource)
```
    The Self-Managed Apache Kafka cluster to send records.
    
    Parameters:
    
    selfManagedEventSource - The Self-Managed Apache Kafka cluster to send records.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFunctionResponseTypes
```
public List<String> getFunctionResponseTypes()
```
    (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
    
    Returns:
    
    (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)
```
    (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
    
    Parameters:
    
    functionResponseTypes - (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
    
    See Also:
    
    FunctionResponseType
  - withFunctionResponseTypes
```
public CreateEventSourceMappingRequest withFunctionResponseTypes(String... functionResponseTypes)
```
    (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 - (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 CreateEventSourceMappingRequest withFunctionResponseTypes(Collection<String> functionResponseTypes)
```
    (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
    
    Parameters:
    
    functionResponseTypes - (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 CreateEventSourceMappingRequest withFunctionResponseTypes(FunctionResponseType... functionResponseTypes)
```
    (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
    
    Parameters:
    
    functionResponseTypes - (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
  - 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 CreateEventSourceMappingRequest 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()

Did this page help you?

Class CreateEventSourceMappingRequest

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

CreateEventSourceMappingRequest

Method Detail

setEventSourceArn

getEventSourceArn

withEventSourceArn

setFunctionName

getFunctionName

withFunctionName

setEnabled

getEnabled

withEnabled

isEnabled

setBatchSize

getBatchSize

withBatchSize

setFilterCriteria

getFilterCriteria

withFilterCriteria

setMaximumBatchingWindowInSeconds

getMaximumBatchingWindowInSeconds

withMaximumBatchingWindowInSeconds

setParallelizationFactor

getParallelizationFactor

withParallelizationFactor

setStartingPosition

getStartingPosition

withStartingPosition

setStartingPosition

withStartingPosition

setStartingPositionTimestamp

getStartingPositionTimestamp

withStartingPositionTimestamp

setDestinationConfig

getDestinationConfig

withDestinationConfig

setMaximumRecordAgeInSeconds

getMaximumRecordAgeInSeconds

withMaximumRecordAgeInSeconds

setBisectBatchOnFunctionError

getBisectBatchOnFunctionError

withBisectBatchOnFunctionError

isBisectBatchOnFunctionError

setMaximumRetryAttempts

getMaximumRetryAttempts

withMaximumRetryAttempts

setTumblingWindowInSeconds

getTumblingWindowInSeconds

withTumblingWindowInSeconds

getTopics

setTopics

withTopics

withTopics

getQueues

setQueues

withQueues

withQueues

getSourceAccessConfigurations

setSourceAccessConfigurations

withSourceAccessConfigurations

withSourceAccessConfigurations

setSelfManagedEventSource

getSelfManagedEventSource

withSelfManagedEventSource

getFunctionResponseTypes

setFunctionResponseTypes

withFunctionResponseTypes

withFunctionResponseTypes

withFunctionResponseTypes

toString

equals

hashCode