com.amazonaws.services.lambda.model

Class CreateEventSourceMappingRequest

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()

Method Summary

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 items to retrieve in a single batch.
Boolean	getBisectBatchOnFunctionError() (Streams) If the function returns an error, split the batch in two and retry.
DestinationConfig	getDestinationConfig() (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
Boolean	getEnabled() Disables the event source mapping to pause polling and invocation.
String	getEventSourceArn() The Amazon Resource Name (ARN) of the event source.
String	getFunctionName() The name of the Lambda function.
Integer	getMaximumBatchingWindowInSeconds() (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
Integer	getMaximumRecordAgeInSeconds() (Streams) The maximum age of a record that Lambda sends to a function for processing.
Integer	getMaximumRetryAttempts() (Streams) The maximum number of times to retry when the function returns an error.
Integer	getParallelizationFactor() (Streams) The number of batches to process from each shard concurrently.
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.
int	hashCode()
Boolean	isBisectBatchOnFunctionError() (Streams) If the function returns an error, split the batch in two and retry.
Boolean	isEnabled() Disables the event source mapping to pause polling and invocation.
void	setBatchSize(Integer batchSize) The maximum number of items to retrieve in a single batch.
void	setBisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError) (Streams) If the function returns an error, split the batch in two and retry.
void	setDestinationConfig(DestinationConfig destinationConfig) (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
void	setEnabled(Boolean enabled) Disables the event source mapping to pause polling and invocation.
void	setEventSourceArn(String eventSourceArn) The Amazon Resource Name (ARN) of the event source.
void	setFunctionName(String functionName) The name of the Lambda function.
void	setMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds) (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
void	setMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds) (Streams) The maximum age of a record that Lambda sends to a function for processing.
void	setMaximumRetryAttempts(Integer maximumRetryAttempts) (Streams) The maximum number of times to retry when the function returns an error.
void	setParallelizationFactor(Integer parallelizationFactor) (Streams) The number of batches to process from each shard concurrently.
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.
String	toString() Returns a string representation of this object.
CreateEventSourceMappingRequest	withBatchSize(Integer batchSize) The maximum number of items to retrieve in a single batch.
CreateEventSourceMappingRequest	withBisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError) (Streams) If the function returns an error, split the batch in two and retry.
CreateEventSourceMappingRequest	withDestinationConfig(DestinationConfig destinationConfig) (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
CreateEventSourceMappingRequest	withEnabled(Boolean enabled) Disables the event source mapping to pause polling and invocation.
CreateEventSourceMappingRequest	withEventSourceArn(String eventSourceArn) The Amazon Resource Name (ARN) of the event source.
CreateEventSourceMappingRequest	withFunctionName(String functionName) The name of the Lambda function.
CreateEventSourceMappingRequest	withMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds) (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
CreateEventSourceMappingRequest	withMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds) (Streams) The maximum age of a record that Lambda sends to a function for processing.
CreateEventSourceMappingRequest	withMaximumRetryAttempts(Integer maximumRetryAttempts) (Streams) The maximum number of times to retry when the function returns an error.
CreateEventSourceMappingRequest	withParallelizationFactor(Integer parallelizationFactor) (Streams) The number of batches to process from each shard concurrently.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

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.

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.

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.

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.

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.

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.

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)

Disables the event source mapping to pause polling and invocation.

Parameters:

enabled - Disables the event source mapping to pause polling and invocation.

getEnabled

public Boolean getEnabled()

Disables the event source mapping to pause polling and invocation.

Returns:

Disables the event source mapping to pause polling and invocation.

withEnabled

public CreateEventSourceMappingRequest withEnabled(Boolean enabled)

Disables the event source mapping to pause polling and invocation.

Parameters:

enabled - Disables the event source mapping to pause polling and invocation.

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnabled

public Boolean isEnabled()

Disables the event source mapping to pause polling and invocation.

Returns:

Disables the event source mapping to pause polling and invocation.

setBatchSize

public void setBatchSize(Integer batchSize)

The maximum number of items to retrieve in a single batch.

• Amazon Kinesis - Default 100. Max 10,000.

• Amazon DynamoDB Streams - Default 100. Max 1,000.

• Amazon Simple Queue Service - Default 10. Max 10.

Parameters:

batchSize - The maximum number of items to retrieve in a single batch.

• Amazon Kinesis - Default 100. Max 10,000.

• Amazon DynamoDB Streams - Default 100. Max 1,000.

• Amazon Simple Queue Service - Default 10. Max 10.

getBatchSize

public Integer getBatchSize()

The maximum number of items to retrieve in a single batch.

• Amazon Kinesis - Default 100. Max 10,000.

• Amazon DynamoDB Streams - Default 100. Max 1,000.

• Amazon Simple Queue Service - Default 10. Max 10.

Returns:

The maximum number of items to retrieve in a single batch.

• Amazon Kinesis - Default 100. Max 10,000.

• Amazon DynamoDB Streams - Default 100. Max 1,000.

• Amazon Simple Queue Service - Default 10. Max 10.

withBatchSize

public CreateEventSourceMappingRequest withBatchSize(Integer batchSize)

The maximum number of items to retrieve in a single batch.

• Amazon Kinesis - Default 100. Max 10,000.

• Amazon DynamoDB Streams - Default 100. Max 1,000.

• Amazon Simple Queue Service - Default 10. Max 10.

Parameters:

batchSize - The maximum number of items to retrieve in a single batch.

• Amazon Kinesis - Default 100. Max 10,000.

• Amazon DynamoDB Streams - Default 100. Max 1,000.

• Amazon Simple Queue Service - Default 10. Max 10.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaximumBatchingWindowInSeconds

public void setMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

Parameters:

maximumBatchingWindowInSeconds - (Streams) The maximum amount of time to gather records before invoking the function, in seconds.

getMaximumBatchingWindowInSeconds

public Integer getMaximumBatchingWindowInSeconds()

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

Returns:

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

withMaximumBatchingWindowInSeconds

public CreateEventSourceMappingRequest withMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

Parameters:

maximumBatchingWindowInSeconds - (Streams) The maximum amount of time to gather records before invoking the function, in seconds.

Returns:

Returns a reference to this object so that method calls can be chained together.

setParallelizationFactor

public void setParallelizationFactor(Integer parallelizationFactor)

(Streams) The number of batches to process from each shard concurrently.

Parameters:

parallelizationFactor - (Streams) The number of batches to process from each shard concurrently.

getParallelizationFactor

public Integer getParallelizationFactor()

(Streams) The number of batches to process from each shard concurrently.

Returns:

(Streams) The number of batches to process from each shard concurrently.

withParallelizationFactor

public CreateEventSourceMappingRequest withParallelizationFactor(Integer parallelizationFactor)

(Streams) The number of batches to process from each shard concurrently.

Parameters:

parallelizationFactor - (Streams) 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 and Amazon DynamoDB 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 and Amazon DynamoDB 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 and Amazon DynamoDB 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 and Amazon DynamoDB 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 and Amazon DynamoDB 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 and Amazon DynamoDB 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 and Amazon DynamoDB 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 and Amazon DynamoDB 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 and Amazon DynamoDB 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 and Amazon DynamoDB 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) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

Parameters:

destinationConfig - (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

getDestinationConfig

public DestinationConfig getDestinationConfig()

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

Returns:

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

withDestinationConfig

public CreateEventSourceMappingRequest withDestinationConfig(DestinationConfig destinationConfig)

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

Parameters:

destinationConfig - (Streams) 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) The maximum age of a record that Lambda sends to a function for processing.

Parameters:

maximumRecordAgeInSeconds - (Streams) The maximum age of a record that Lambda sends to a function for processing.

getMaximumRecordAgeInSeconds

public Integer getMaximumRecordAgeInSeconds()

(Streams) The maximum age of a record that Lambda sends to a function for processing.

Returns:

(Streams) The maximum age of a record that Lambda sends to a function for processing.

withMaximumRecordAgeInSeconds

public CreateEventSourceMappingRequest withMaximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)

(Streams) The maximum age of a record that Lambda sends to a function for processing.

Parameters:

maximumRecordAgeInSeconds - (Streams) The maximum age of a record that Lambda sends to a function for processing.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBisectBatchOnFunctionError

public void setBisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)

(Streams) If the function returns an error, split the batch in two and retry.

Parameters:

bisectBatchOnFunctionError - (Streams) If the function returns an error, split the batch in two and retry.

getBisectBatchOnFunctionError

public Boolean getBisectBatchOnFunctionError()

(Streams) If the function returns an error, split the batch in two and retry.

Returns:

(Streams) If the function returns an error, split the batch in two and retry.

withBisectBatchOnFunctionError

public CreateEventSourceMappingRequest withBisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)

(Streams) If the function returns an error, split the batch in two and retry.

Parameters:

bisectBatchOnFunctionError - (Streams) 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) If the function returns an error, split the batch in two and retry.

Returns:

(Streams) If the function returns an error, split the batch in two and retry.

setMaximumRetryAttempts

public void setMaximumRetryAttempts(Integer maximumRetryAttempts)

(Streams) The maximum number of times to retry when the function returns an error.

Parameters:

maximumRetryAttempts - (Streams) The maximum number of times to retry when the function returns an error.

getMaximumRetryAttempts

public Integer getMaximumRetryAttempts()

(Streams) The maximum number of times to retry when the function returns an error.

Returns:

(Streams) The maximum number of times to retry when the function returns an error.

withMaximumRetryAttempts

public CreateEventSourceMappingRequest withMaximumRetryAttempts(Integer maximumRetryAttempts)

(Streams) The maximum number of times to retry when the function returns an error.

Parameters:

maximumRetryAttempts - (Streams) The maximum number of times to retry when the function returns an error.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public 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()