Class CreateEventSourceMappingRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.Indicates whether AWS Lambda should begin polling the event source.The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source.The Lambda function to invoke when AWS Lambda detects an event on the stream.The position in the stream where AWS Lambda should start reading.int
hashCode()
Indicates whether AWS Lambda should begin polling the event source.void
setBatchSize
(Integer batchSize) The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.void
setEnabled
(Boolean enabled) Indicates whether AWS Lambda should begin polling the event source.void
setEventSourceArn
(String eventSourceArn) The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source.void
setFunctionName
(String functionName) The Lambda function to invoke when AWS Lambda detects an event on the stream.void
setStartingPosition
(EventSourcePosition startingPosition) The position in the stream where AWS Lambda should start reading.void
setStartingPosition
(String startingPosition) The position in the stream where AWS Lambda should start reading.toString()
Returns a string representation of this object; useful for testing and debugging.withBatchSize
(Integer batchSize) The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.withEnabled
(Boolean enabled) Indicates whether AWS Lambda should begin polling the event source.withEventSourceArn
(String eventSourceArn) The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source.withFunctionName
(String functionName) The Lambda function to invoke when AWS Lambda detects an event on the stream.withStartingPosition
(EventSourcePosition startingPosition) The position in the stream where AWS Lambda should start reading.withStartingPosition
(String startingPosition) The position in the stream where AWS Lambda should start reading.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
CreateEventSourceMappingRequest
public CreateEventSourceMappingRequest()
-
-
Method Details
-
setEventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on the
BatchSize
. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.- Parameters:
eventSourceArn
- The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on theBatchSize
. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.
-
getEventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on the
BatchSize
. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.- Returns:
- The Amazon Resource Name (ARN) of the Amazon Kinesis or the
Amazon DynamoDB stream that is the event source. Any record added
to this stream could cause AWS Lambda to invoke your Lambda
function, it depends on the
BatchSize
. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.
-
withEventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on the
BatchSize
. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.- Parameters:
eventSourceArn
- The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on theBatchSize
. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setFunctionName
The Lambda function to invoke when AWS Lambda detects an event on the stream.
You can specify the function name (for example,
Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
).If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases
AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example,
account-id:Thumbnail
).Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
- Parameters:
functionName
- The Lambda function to invoke when AWS Lambda detects an event on the stream.You can specify the function name (for example,
Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
).If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases
AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example,
account-id:Thumbnail
).Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
-
getFunctionName
The Lambda function to invoke when AWS Lambda detects an event on the stream.
You can specify the function name (for example,
Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
).If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases
AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example,
account-id:Thumbnail
).Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
- Returns:
- The Lambda function to invoke when AWS Lambda detects an event on
the stream.
You can specify the function name (for example,
Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
).If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases
AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example,
account-id:Thumbnail
).Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
-
withFunctionName
The Lambda function to invoke when AWS Lambda detects an event on the stream.
You can specify the function name (for example,
Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
).If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases
AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example,
account-id:Thumbnail
).Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
- Parameters:
functionName
- The Lambda function to invoke when AWS Lambda detects an event on the stream.You can specify the function name (for example,
Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
).If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases
AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example,
account-id:Thumbnail
).Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEnabled
Indicates whether AWS Lambda should begin polling the event source. By default,
Enabled
is true.- Parameters:
enabled
- Indicates whether AWS Lambda should begin polling the event source. By default,Enabled
is true.
-
getEnabled
Indicates whether AWS Lambda should begin polling the event source. By default,
Enabled
is true.- Returns:
- Indicates whether AWS Lambda should begin polling the event
source. By default,
Enabled
is true.
-
withEnabled
Indicates whether AWS Lambda should begin polling the event source. By default,
Enabled
is true.- Parameters:
enabled
- Indicates whether AWS Lambda should begin polling the event source. By default,Enabled
is true.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isEnabled
Indicates whether AWS Lambda should begin polling the event source. By default,
Enabled
is true.- Returns:
- Indicates whether AWS Lambda should begin polling the event
source. By default,
Enabled
is true.
-
setBatchSize
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.
- Parameters:
batchSize
- The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.
-
getBatchSize
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.
- Returns:
- The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.
-
withBatchSize
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.
- Parameters:
batchSize
- The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStartingPosition
The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
- Parameters:
startingPosition
- The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.- See Also:
-
getStartingPosition
The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
- Returns:
- The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
- See Also:
-
withStartingPosition
The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
- Parameters:
startingPosition
- The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setStartingPosition
The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
- Parameters:
startingPosition
- The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.- See Also:
-
withStartingPosition
The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
- Parameters:
startingPosition
- The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-