com.amazonaws.services.lambda.model

Class UpdateEventSourceMappingRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lambda.model.UpdateEventSourceMappingRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UpdateEventSourceMappingRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the UpdateEventSourceMapping operation.

You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.

If you are using the versioning feature, you can update the event source mapping to map to a specific Lambda function version or alias as described in the FunctionName parameter. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases .

If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset.

This operation requires permission for the lambda:UpdateEventSourceMapping action.

See Also:

AWSLambda.updateEventSourceMapping(UpdateEventSourceMappingRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateEventSourceMappingRequest()

Method Summary

Methods

Modifier and Type	Method and Description
UpdateEventSourceMappingRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Integer	getBatchSize() The maximum number of stream records that can be sent to your Lambda function for a single invocation.
Boolean	getEnabled() Specifies whether AWS Lambda should actively poll the stream or not.
String	getFunctionName() The Lambda function to which you want the stream records sent.
String	getUUID() The event source mapping identifier.
int	hashCode()
Boolean	isEnabled() Specifies whether AWS Lambda should actively poll the stream or not.
void	setBatchSize(Integer batchSize) The maximum number of stream records that can be sent to your Lambda function for a single invocation.
void	setEnabled(Boolean enabled) Specifies whether AWS Lambda should actively poll the stream or not.
void	setFunctionName(String functionName) The Lambda function to which you want the stream records sent.
void	setUUID(String uUID) The event source mapping identifier.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateEventSourceMappingRequest	withBatchSize(Integer batchSize) The maximum number of stream records that can be sent to your Lambda function for a single invocation.
UpdateEventSourceMappingRequest	withEnabled(Boolean enabled) Specifies whether AWS Lambda should actively poll the stream or not.
UpdateEventSourceMappingRequest	withFunctionName(String functionName) The Lambda function to which you want the stream records sent.
UpdateEventSourceMappingRequest	withUUID(String uUID) The event source mapping identifier.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateEventSourceMappingRequest

public UpdateEventSourceMappingRequest()

Method Detail

getUUID

public String getUUID()

The event source mapping identifier.

Returns:

The event source mapping identifier.

setUUID

public void setUUID(String uUID)

The event source mapping identifier.

Parameters:

uUID - The event source mapping identifier.

withUUID

public UpdateEventSourceMappingRequest withUUID(String uUID)

The event source mapping identifier.

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

Parameters:

uUID - The event source mapping identifier.

Returns:

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

getFunctionName

public String getFunctionName()

The Lambda function to which you want the stream records sent.

You can specify a 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). AWS Lambda also allows you to specify a partial ARN (for example, account-id: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

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.

Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?

Returns:

The Lambda function to which you want the stream records sent.

You can specify a 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). AWS Lambda also allows you to specify a partial ARN (for example, account-id: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

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.

setFunctionName

public void setFunctionName(String functionName)

The Lambda function to which you want the stream records sent.

You can specify a 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). AWS Lambda also allows you to specify a partial ARN (for example, account-id: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

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.

Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?

Parameters:

functionName - The Lambda function to which you want the stream records sent.

You can specify a 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). AWS Lambda also allows you to specify a partial ARN (for example, account-id: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

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

public UpdateEventSourceMappingRequest withFunctionName(String functionName)

The Lambda function to which you want the stream records sent.

You can specify a 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). AWS Lambda also allows you to specify a partial ARN (for example, account-id: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

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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?

Parameters:

functionName - The Lambda function to which you want the stream records sent.

You can specify a 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). AWS Lambda also allows you to specify a partial ARN (for example, account-id: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

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:

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

isEnabled

public Boolean isEnabled()

Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

Returns:

Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

setEnabled

public void setEnabled(Boolean enabled)

Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

Parameters:

enabled - Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

withEnabled

public UpdateEventSourceMappingRequest withEnabled(Boolean enabled)

Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

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

Parameters:

enabled - Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

Returns:

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

getEnabled

public Boolean getEnabled()

Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

Returns:

Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

getBatchSize

public Integer getBatchSize()

The maximum number of stream records that can be sent to your Lambda function for a single invocation.

Constraints:
Range: 1 - 10000

Returns:

The maximum number of stream records that can be sent to your Lambda function for a single invocation.

setBatchSize

public void setBatchSize(Integer batchSize)

The maximum number of stream records that can be sent to your Lambda function for a single invocation.

Constraints:
Range: 1 - 10000

Parameters:

batchSize - The maximum number of stream records that can be sent to your Lambda function for a single invocation.

withBatchSize

public UpdateEventSourceMappingRequest withBatchSize(Integer batchSize)

The maximum number of stream records that can be sent to your Lambda function for a single invocation.

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

Constraints:
Range: 1 - 10000

Parameters:

batchSize - The maximum number of stream records that can be sent to your Lambda function for a single invocation.

Returns:

A reference to this updated 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 UpdateEventSourceMappingRequest 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 class AmazonWebServiceRequest

See Also:

Object.clone()