software.amazon.awssdk.services.lambda.model

Class UpdateFunctionConfigurationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lambda.model.LambdaRequest

software.amazon.awssdk.services.lambda.model.UpdateFunctionConfigurationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateFunctionConfigurationRequest.Builder,UpdateFunctionConfigurationRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateFunctionConfigurationRequest
extends LambdaRequest
implements ToCopyableBuilder<UpdateFunctionConfigurationRequest.Builder,UpdateFunctionConfigurationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateFunctionConfigurationRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateFunctionConfigurationRequest.Builder	builder()
DeadLetterConfig	deadLetterConfig() A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.
String	description() A short user-defined function description.
Environment	environment() The parent object that contains your environment's configuration settings.
boolean	equals(Object obj)
String	functionName() The name of the Lambda function.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
String	handler() The function that Lambda calls to begin executing your function.
int	hashCode()
String	kmsKeyArn() The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables.
List<String>	layers() A list of function layers to add to the function's execution environment.
Integer	memorySize() The amount of memory, in MB, your Lambda function is given.
String	revisionId() An optional value you can use to ensure you are updating the latest update of the function version or alias.
String	role() The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
Runtime	runtime() The runtime version for the function.
String	runtimeAsString() The runtime version for the function.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateFunctionConfigurationRequest.Builder>	serializableBuilderClass()
Integer	timeout() The amount of time that Lambda allows a function to run before terminating it.
UpdateFunctionConfigurationRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
TracingConfig	tracingConfig() Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.
VpcConfig	vpcConfig() Specify security groups and subnets in a VPC to which your Lambda function needs access.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

functionName

public String functionName()

The name of the Lambda function.

Name formats

• Function name - MyFunction.

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

• Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Returns:

The name of the Lambda function.

Name formats

• Function name - MyFunction.

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

• Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

role

public String role()

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

Returns:

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

handler

public 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:

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

description

public 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 short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

timeout

public Integer timeout()

The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.

Returns:

The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.

memorySize

public 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:

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.

vpcConfig

public VpcConfig vpcConfig()

Specify security groups and subnets in a VPC to which your Lambda function needs access.

Returns:

Specify security groups and subnets in a VPC to which your Lambda function needs access.

environment

public Environment environment()

The parent object that contains your environment's configuration settings.

Returns:

The parent object that contains your environment's configuration settings.

runtime

public Runtime runtime()

The runtime version for the function.

If the service returns an enum value that is not available in the current SDK version, runtime will return Runtime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from runtimeAsString().

Returns:

The runtime version for the function.

See Also:

Runtime

runtimeAsString

public String runtimeAsString()

The runtime version for the function.

If the service returns an enum value that is not available in the current SDK version, runtime will return Runtime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from runtimeAsString().

Returns:

The runtime version for the function.

See Also:

Runtime

deadLetterConfig

public DeadLetterConfig deadLetterConfig()

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.

Returns:

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.

kmsKeyArn

public String kmsKeyArn()

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string ("") for this parameter.

Returns:

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string ("") for this parameter.

tracingConfig

public TracingConfig tracingConfig()

Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.

Returns:

Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.

revisionId

public String revisionId()

An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias.

Returns:

An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias.

layers

public List<String> layers()

A list of function layers to add to the function's execution environment.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of function layers to add to the function's execution environment.

toBuilder

public UpdateFunctionConfigurationRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateFunctionConfigurationRequest.Builder,UpdateFunctionConfigurationRequest>

Specified by:

toBuilder in class LambdaRequest

Returns:

a builder for type T

builder

public static UpdateFunctionConfigurationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateFunctionConfigurationRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.