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 description of the function.
Environment	environment() Environment variables that are accessible from function code during execution.
EphemeralStorage	ephemeralStorage() The size of the function's /tmp directory in MB.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FileSystemConfig>	fileSystemConfigs() Connection settings for an Amazon EFS file system.
String	functionName() The name of the Lambda function.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	handler() The name of the method within your code that Lambda calls to run your function.
boolean	hasFileSystemConfigs() For responses, this returns true if the service returned a value for the FileSystemConfigs property.
int	hashCode()
boolean	hasLayers() For responses, this returns true if the service returned a value for the Layers property.
ImageConfig	imageConfig() Container image configuration values that override the values in the container image Docker file.
String	kmsKeyArn() The ARN of the Key Management Service (KMS) customer managed key that's 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 available to the function at runtime.
String	revisionId() Update the function only if the revision ID matches the ID that's specified.
String	role() The Amazon Resource Name (ARN) of the function's execution role.
Runtime	runtime() The identifier of the function's runtime.
String	runtimeAsString() The identifier of the function's runtime.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateFunctionConfigurationRequest.Builder>	serializableBuilderClass()
SnapStart	snapStart() The function's SnapStart setting.
Integer	timeout() The amount of time (in seconds) that Lambda allows a function to run before stopping it.
UpdateFunctionConfigurationRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TracingConfig	tracingConfig() Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.
VpcConfig	vpcConfig() For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC.

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

overrideConfiguration

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

functionName

public final String functionName()

The name of the Lambda function.

Name formats

• Function name – my-function.

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

• Partial ARN – 123456789012:function:my-function.

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 – my-function.

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

• Partial ARN – 123456789012:function:my-function.

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 final String role()

The Amazon Resource Name (ARN) of the function's execution role.

Returns:

The Amazon Resource Name (ARN) of the function's execution role.

handler

public final String handler()

The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

Returns:

The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

description

public final String description()

A description of the function.

Returns:

A description of the function.

timeout

public final Integer timeout()

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

Returns:

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

memorySize

public final Integer memorySize()

The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

Returns:

The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

vpcConfig

public final VpcConfig vpcConfig()

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

Returns:

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

environment

public final Environment environment()

Environment variables that are accessible from function code during execution.

Returns:

Environment variables that are accessible from function code during execution.

runtime

public final Runtime runtime()

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

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 identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

See Also:

Runtime

runtimeAsString

public final String runtimeAsString()

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

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 identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

See Also:

Runtime

deadLetterConfig

public final 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 final String kmsKeyArn()

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.

Returns:

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.

tracingConfig

public final TracingConfig tracingConfig()

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

Returns:

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

revisionId

public final String revisionId()

Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.

Returns:

Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.

hasLayers

public final boolean hasLayers()

For responses, this returns true if the service returned a value for the Layers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

layers

public final List<String> layers()

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLayers() method.

Returns:

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

hasFileSystemConfigs

public final boolean hasFileSystemConfigs()

For responses, this returns true if the service returned a value for the FileSystemConfigs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

fileSystemConfigs

public final List<FileSystemConfig> fileSystemConfigs()

Connection settings for an Amazon EFS file system.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFileSystemConfigs() method.

Returns:

Connection settings for an Amazon EFS file system.

imageConfig

public final ImageConfig imageConfig()

Container image configuration values that override the values in the container image Docker file.

Returns:

Container image configuration values that override the values in the container image Docker file.

ephemeralStorage

public final EphemeralStorage ephemeralStorage()

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB.

Returns:

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB.

snapStart

public final SnapStart snapStart()

The function's SnapStart setting.

Returns:

The function's SnapStart setting.

toBuilder

public UpdateFunctionConfigurationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateFunctionConfigurationRequest.Builder,UpdateFunctionConfigurationRequest>

Specified by:

toBuilder in class LambdaRequest

builder

public static UpdateFunctionConfigurationRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo