com.amazonaws.services.lambda.model

Class UpdateFunctionConfigurationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lambda.model.UpdateFunctionConfigurationRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UpdateFunctionConfigurationRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the UpdateFunctionConfiguration operation.

Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.

This operation requires permission for the lambda:UpdateFunctionConfiguration action.

See Also:

AWSLambda.updateFunctionConfiguration(UpdateFunctionConfigurationRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateFunctionConfigurationRequest()

Method Summary

Methods

Modifier and Type	Method and Description
UpdateFunctionConfigurationRequest	clone()
boolean	equals(Object obj)
String	getDescription() A short user-defined function description.
String	getFunctionName() The name of the Lambda function.
String	getHandler() The function that Lambda calls to begin executing your function.
Integer	getMemorySize() The amount of memory, in MB, your Lambda function is given.
String	getRole() The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
Integer	getTimeout() The function execution time at which AWS Lambda should terminate the function.
int	hashCode()
void	setDescription(String description) A short user-defined function description.
void	setFunctionName(String functionName) The name of the Lambda function.
void	setHandler(String handler) The function that Lambda calls to begin executing your function.
void	setMemorySize(Integer memorySize) The amount of memory, in MB, your Lambda function is given.
void	setRole(String role) The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
void	setTimeout(Integer timeout) The function execution time at which AWS Lambda should terminate the function.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateFunctionConfigurationRequest	withDescription(String description) A short user-defined function description.
UpdateFunctionConfigurationRequest	withFunctionName(String functionName) The name of the Lambda function.
UpdateFunctionConfigurationRequest	withHandler(String handler) The function that Lambda calls to begin executing your function.
UpdateFunctionConfigurationRequest	withMemorySize(Integer memorySize) The amount of memory, in MB, your Lambda function is given.
UpdateFunctionConfigurationRequest	withRole(String role) The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
UpdateFunctionConfigurationRequest	withTimeout(Integer timeout) The function execution time at which AWS Lambda should terminate 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

UpdateFunctionConfigurationRequest

public UpdateFunctionConfigurationRequest()

Method Detail

getFunctionName

public String getFunctionName()

The name of the Lambda function.

You can specify an unqualified 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 only 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.

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

Returns:

The name of the Lambda function.

You can specify an unqualified 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 only 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.

setFunctionName

public void setFunctionName(String functionName)

The name of the Lambda function.

You can specify an unqualified 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 only 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.

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

Parameters:

functionName - The name of the Lambda function.

You can specify an unqualified 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 only 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

public UpdateFunctionConfigurationRequest withFunctionName(String functionName)

The name of the Lambda function.

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

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

Parameters:

functionName - The name of the Lambda function.

You can specify an unqualified 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 only 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:

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

getRole

public String getRole()

The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

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

Returns:

The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

setRole

public void setRole(String role)

The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

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

Parameters:

role - The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

withRole

public UpdateFunctionConfigurationRequest withRole(String role)

The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your 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 Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

Returns:

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

getHandler

public String getHandler()

The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

Constraints:
Length: 0 - 128
Pattern: [a-zA-Z0-9./\-_]+

Returns:

The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

setHandler

public void setHandler(String handler)

The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

Constraints:
Length: 0 - 128
Pattern: [a-zA-Z0-9./\-_]+

Parameters:

handler - The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

withHandler

public UpdateFunctionConfigurationRequest withHandler(String handler)

The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

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

Constraints:
Length: 0 - 128
Pattern: [a-zA-Z0-9./\-_]+

Parameters:

handler - The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

Returns:

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

getDescription

public String getDescription()

A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

Constraints:
Length: 0 - 256

Returns:

A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

setDescription

public void setDescription(String description)

A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

Constraints:
Length: 0 - 256

Parameters:

description - A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

withDescription

public UpdateFunctionConfigurationRequest withDescription(String description)

A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

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

Constraints:
Length: 0 - 256

Parameters:

description - A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

Returns:

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

getTimeout

public Integer getTimeout()

The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

Constraints:
Range: 1 - 60

Returns:

The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

setTimeout

public void setTimeout(Integer timeout)

The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

Constraints:
Range: 1 - 60

Parameters:

timeout - The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

withTimeout

public UpdateFunctionConfigurationRequest withTimeout(Integer timeout)

The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

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

Constraints:
Range: 1 - 60

Parameters:

timeout - The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

Returns:

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

getMemorySize

public Integer getMemorySize()

The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

Constraints:
Range: 128 - 1024

Returns:

The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

setMemorySize

public void setMemorySize(Integer memorySize)

The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

Constraints:
Range: 128 - 1024

Parameters:

memorySize - The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

withMemorySize

public UpdateFunctionConfigurationRequest withMemorySize(Integer memorySize)

The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

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

Constraints:
Range: 128 - 1024

Parameters:

memorySize - The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

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

Overrides:

clone in class AmazonWebServiceRequest