Class UpdateFunctionConfigurationRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateFunctionConfigurationRequest.Builder,
UpdateFunctionConfigurationRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final DeadLetterConfig
A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.final String
A description of the function.final Environment
Environment variables that are accessible from function code during execution.final EphemeralStorage
The size of the function's/tmp
directory in MB.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<FileSystemConfig> Connection settings for an Amazon EFS file system.final String
The name or ARN of the Lambda function.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final String
handler()
The name of the method within your code that Lambda calls to run your function.final boolean
For responses, this returns true if the service returned a value for the FileSystemConfigs property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Layers property.final ImageConfig
Container image configuration values that override the values in the container image Docker file.final String
The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables.layers()
A list of function layers to add to the function's execution environment.final LoggingConfig
The function's Amazon CloudWatch Logs configuration settings.final Integer
The amount of memory available to the function at runtime.final String
Update the function only if the revision ID matches the ID that's specified.final String
role()
The Amazon Resource Name (ARN) of the function's execution role.final Runtime
runtime()
The identifier of the function's runtime.final String
The identifier of the function's runtime.static Class
<? extends UpdateFunctionConfigurationRequest.Builder> final SnapStart
The function's SnapStart setting.final Integer
timeout()
The amount of time (in seconds) that Lambda allows a function to run before stopping it.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TracingConfig
final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
functionName
The name or ARN 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 or ARN 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
The Amazon Resource Name (ARN) of the function's execution role.
- Returns:
- The Amazon Resource Name (ARN) of the function's execution role.
-
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
A description of the function.
- Returns:
- A description of the function.
-
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
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
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
Environment variables that are accessible from function code during execution.
- Returns:
- Environment variables that are accessible from function code during execution.
-
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 returnRuntime.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromruntimeAsString()
.- 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:
-
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 returnRuntime.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromruntimeAsString()
.- 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:
-
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
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
Set
Mode
toActive
to sample and trace a subset of incoming requests with X-Ray.- Returns:
- Set
Mode
toActive
to sample and trace a subset of incoming requests with X-Ray.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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
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. For more information, see Configuring ephemeral storage (console).- 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. For more information, see Configuring ephemeral storage (console).
-
snapStart
The function's SnapStart setting.
- Returns:
- The function's SnapStart setting.
-
loggingConfig
The function's Amazon CloudWatch Logs configuration settings.
- Returns:
- The function's Amazon CloudWatch Logs configuration settings.
-
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 interfaceToCopyableBuilder<UpdateFunctionConfigurationRequest.Builder,
UpdateFunctionConfigurationRequest> - Specified by:
toBuilder
in classLambdaRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends UpdateFunctionConfigurationRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-