public class UpdateFunctionConfigurationRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
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.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases .
This operation requires permission for the
lambda:UpdateFunctionConfiguration
action.
NOOP
Constructor and Description |
---|
UpdateFunctionConfigurationRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateFunctionConfigurationRequest |
clone()
Creates a shallow clone of this request.
|
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.
|
String |
getRuntime()
Returns the value of the Runtime property for this object.
|
Integer |
getTimeout()
The function execution time at which AWS Lambda should terminate the
function.
|
VpcConfig |
getVpcConfig()
If your Lambda function accesses resources in a VPC, you provide this
parameter identifying the list of security group IDs and subnet IDs.
|
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 |
setRuntime(Runtime runtime)
Sets the value of the Runtime property for this object.
|
void |
setRuntime(String runtime)
Sets the value of the Runtime property for this object.
|
void |
setTimeout(Integer timeout)
The function execution time at which AWS Lambda should terminate the
function.
|
void |
setVpcConfig(VpcConfig vpcConfig)
If your Lambda function accesses resources in a VPC, you provide this
parameter identifying the list of security group IDs and subnet IDs.
|
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 |
withRuntime(Runtime runtime)
Sets the value of the Runtime property for this object.
|
UpdateFunctionConfigurationRequest |
withRuntime(String runtime)
Sets the value of the Runtime property for this object.
|
UpdateFunctionConfigurationRequest |
withTimeout(Integer timeout)
The function execution time at which AWS Lambda should terminate the
function.
|
UpdateFunctionConfigurationRequest |
withVpcConfig(VpcConfig vpcConfig)
If your Lambda function accesses resources in a VPC, you provide this
parameter identifying the list of security group IDs and subnet IDs.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public String getFunctionName()
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
). 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-_]+))?
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
). 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.
public void setFunctionName(String functionName)
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
). 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-_]+))?
functionName
- The name of the Lambda function. 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
). 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.
public UpdateFunctionConfigurationRequest withFunctionName(String functionName)
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
). 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-_]+))?
functionName
- The name of the Lambda function. 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
). 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.
public String getRole()
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
public void setRole(String role)
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
role
- The Amazon Resource Name (ARN) of the IAM role that Lambda will assume
when it executes your function.public UpdateFunctionConfigurationRequest withRole(String role)
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+=,.@\-_/]+
role
- The Amazon Resource Name (ARN) of the IAM role that Lambda will assume
when it executes your function.public String getHandler()
module-name.export
value in your
function.
Constraints:
Length: 0 - 128
Pattern: [^\s]+
module-name.export
value in your
function.public void setHandler(String handler)
module-name.export
value in your
function.
Constraints:
Length: 0 - 128
Pattern: [^\s]+
handler
- The function that Lambda calls to begin executing your function. For
Node.js, it is the module-name.export
value in your
function.public UpdateFunctionConfigurationRequest withHandler(String handler)
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: [^\s]+
handler
- The function that Lambda calls to begin executing your function. For
Node.js, it is the module-name.export
value in your
function.public String getDescription()
Constraints:
Length: 0 - 256
public void setDescription(String description)
Constraints:
Length: 0 - 256
description
- A short user-defined function description. AWS Lambda does not use
this value. Assign a meaningful description as you see fit.public UpdateFunctionConfigurationRequest withDescription(String description)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 256
description
- A short user-defined function description. AWS Lambda does not use
this value. Assign a meaningful description as you see fit.public Integer getTimeout()
Constraints:
Range: 1 -
public void setTimeout(Integer timeout)
Constraints:
Range: 1 -
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.public UpdateFunctionConfigurationRequest withTimeout(Integer timeout)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 -
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.public Integer getMemorySize()
Constraints:
Range: 128 - 1536
public void setMemorySize(Integer memorySize)
Constraints:
Range: 128 - 1536
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.public UpdateFunctionConfigurationRequest withMemorySize(Integer memorySize)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 128 - 1536
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.public VpcConfig getVpcConfig()
public void setVpcConfig(VpcConfig vpcConfig)
vpcConfig
- If your Lambda function accesses resources in a VPC, you provide this
parameter identifying the list of security group IDs and subnet IDs.
These must belong to the same VPC. You must provide at least one
security group and one subnet ID.public UpdateFunctionConfigurationRequest withVpcConfig(VpcConfig vpcConfig)
Returns a reference to this object so that method calls can be chained together.
vpcConfig
- If your Lambda function accesses resources in a VPC, you provide this
parameter identifying the list of security group IDs and subnet IDs.
These must belong to the same VPC. You must provide at least one
security group and one subnet ID.public String getRuntime()
Constraints:
Allowed Values: nodejs, nodejs4.3, java8, python2.7
Runtime
public void setRuntime(String runtime)
Constraints:
Allowed Values: nodejs, nodejs4.3, java8, python2.7
runtime
- The new value for the Runtime property for this object.Runtime
public UpdateFunctionConfigurationRequest withRuntime(String runtime)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: nodejs, nodejs4.3, java8, python2.7
runtime
- The new value for the Runtime property for this object.Runtime
public void setRuntime(Runtime runtime)
Constraints:
Allowed Values: nodejs, nodejs4.3, java8, python2.7
runtime
- The new value for the Runtime property for this object.Runtime
public UpdateFunctionConfigurationRequest withRuntime(Runtime runtime)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: nodejs, nodejs4.3, java8, python2.7
runtime
- The new value for the Runtime property for this object.Runtime
public String toString()
toString
in class Object
Object.toString()
public UpdateFunctionConfigurationRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.