com.amazonaws.services.lambda.model

Class AddEventSourceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lambda.model.AddEventSourceRequest

All Implemented Interfaces:

Serializable, Cloneable

public class AddEventSourceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the AddEventSource operation.

Identifies a stream as an event source for an AWS Lambda function. It can be either an Amazon Kinesis stream or a Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.

This is the pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.

This association between an Amazon Kinesis stream and an AWS Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which AWS Lambda function to invoke) for the event source mapping in the request body.

Each event source, such as a Kinesis stream, can only be associated with one AWS Lambda function. If you call AddEventSource for an event source that is already mapped to another AWS Lambda function, the existing mapping is updated to call the new function instead of the old one.

This operation requires permission for the iam:PassRole action for the IAM role. It also requires permission for the lambda:AddEventSource action.

See Also:

AWSLambda.addEventSource(AddEventSourceRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AddEventSourceRequest()

Method Summary

Methods

Modifier and Type	Method and Description
AddEventSourceRequest	addParametersEntry(String key, String value) A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source.
AddEventSourceRequest	clearParametersEntries() Removes all the entries added into Parameters.
AddEventSourceRequest	clone()
boolean	equals(Object obj)
Integer	getBatchSize() The largest number of records that AWS Lambda will give to your function in a single event.
String	getEventSource() The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source.
String	getFunctionName() The Lambda function to invoke when AWS Lambda detects an event on the stream.
Map<String,String>	getParameters() A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source.
String	getRole() The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.
int	hashCode()
void	setBatchSize(Integer batchSize) The largest number of records that AWS Lambda will give to your function in a single event.
void	setEventSource(String eventSource) The Amazon Resource Name (ARN) of the Amazon Kinesis 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	setParameters(Map<String,String> parameters) A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source.
void	setRole(String role) The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AddEventSourceRequest	withBatchSize(Integer batchSize) The largest number of records that AWS Lambda will give to your function in a single event.
AddEventSourceRequest	withEventSource(String eventSource) The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source.
AddEventSourceRequest	withFunctionName(String functionName) The Lambda function to invoke when AWS Lambda detects an event on the stream.
AddEventSourceRequest	withParameters(Map<String,String> parameters) A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source.
AddEventSourceRequest	withRole(String role) The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AddEventSourceRequest

public AddEventSourceRequest()

Method Detail

getEventSource

public String getEventSource()

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. 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 stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

setEventSource

public void setEventSource(String eventSource)

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

Parameters:

eventSource - The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

withEventSource

public AddEventSourceRequest withEventSource(String eventSource)

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

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

Parameters:

eventSource - The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

Returns:

A reference to this updated object so that method calls can be chained together.

getFunctionName

public String getFunctionName()

The Lambda function to invoke when AWS Lambda detects an event on the stream.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-_]+

Returns:

The Lambda function to invoke when AWS Lambda detects an event on the stream.

setFunctionName

public void setFunctionName(String functionName)

The Lambda function to invoke when AWS Lambda detects an event on the stream.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-_]+

Parameters:

functionName - The Lambda function to invoke when AWS Lambda detects an event on the stream.

withFunctionName

public AddEventSourceRequest withFunctionName(String functionName)

The Lambda function to invoke when AWS Lambda detects an event on the stream.

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

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-_]+

Parameters:

functionName - The Lambda function to invoke when AWS Lambda detects an event on the stream.

Returns:

A reference to this updated object so that method calls can be chained together.

getRole

public String getRole()

The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Returns:

The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

setRole

public void setRole(String role)

The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Parameters:

role - The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

withRole

public AddEventSourceRequest withRole(String role)

The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

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

Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Parameters:

role - The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

Returns:

A reference to this updated object so that method calls can be chained together.

getBatchSize

public Integer getBatchSize()

The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.

Returns:

The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.

setBatchSize

public void setBatchSize(Integer batchSize)

The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.

Parameters:

batchSize - The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.

withBatchSize

public AddEventSourceRequest withBatchSize(Integer batchSize)

The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.

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

Parameters:

batchSize - The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.

Returns:

A reference to this updated object so that method calls can be chained together.

getParameters

public Map<String,String> getParameters()

A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: "TRIM_HORIZON" and "LATEST". The default value is "TRIM_HORIZON". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.

Returns:

A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: "TRIM_HORIZON" and "LATEST". The default value is "TRIM_HORIZON". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.

setParameters

public void setParameters(Map<String,String> parameters)

A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: "TRIM_HORIZON" and "LATEST". The default value is "TRIM_HORIZON". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.

Parameters:

parameters - A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: "TRIM_HORIZON" and "LATEST". The default value is "TRIM_HORIZON". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.

withParameters

public AddEventSourceRequest withParameters(Map<String,String> parameters)

A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: "TRIM_HORIZON" and "LATEST". The default value is "TRIM_HORIZON". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.

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

Parameters:

parameters - A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: "TRIM_HORIZON" and "LATEST". The default value is "TRIM_HORIZON". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.

Returns:

A reference to this updated object so that method calls can be chained together.

addParametersEntry

public AddEventSourceRequest addParametersEntry(String key,
                                       String value)

A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: "TRIM_HORIZON" and "LATEST". The default value is "TRIM_HORIZON". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.

The method adds a new key-value pair into Parameters parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Parameters.

value - The corresponding value of the entry to be added into Parameters.

clearParametersEntries

public AddEventSourceRequest clearParametersEntries()

Removes all the entries added into Parameters.

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; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public AddEventSourceRequest clone()

Overrides:

clone in class AmazonWebServiceRequest