Class FunctionConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FunctionConfiguration.Builder,
FunctionConfiguration>
Details about a function's configuration.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<Architecture> The instruction set architecture that the function supports.The instruction set architecture that the function supports.builder()
final String
The SHA256 hash of the function's deployment package.final Long
codeSize()
The size of the function's deployment package, in bytes.final DeadLetterConfig
The function's dead letter queue.final String
The function's description.final EnvironmentResponse
The function's environment variables.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 function's Amazon Resource Name (ARN).final String
The name of the function.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final String
handler()
The function that Lambda calls to begin running your function.final boolean
For responses, this returns true if the service returned a value for the Architectures property.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 ImageConfigResponse
The function's image configuration values.final String
The KMS key that's used to encrypt the function's environment variables.final String
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).final LastUpdateStatus
The status of the last update that was performed on the function.final String
The status of the last update that was performed on the function.final String
The reason for the last update that was performed on the function.The reason code for the last update that was performed on the function.final String
The reason code for the last update that was performed on the function.layers()
The function's layers.final LoggingConfig
The function's Amazon CloudWatch Logs configuration settings.final String
For Lambda@Edge functions, the ARN of the main function.final Integer
The amount of memory available to the function at runtime.final PackageType
The type of deployment package.final String
The type of deployment package.final String
The latest updated revision of the function or alias.final String
role()
The function's execution role.final Runtime
runtime()
The identifier of the function's runtime.final String
The identifier of the function's runtime.final RuntimeVersionConfig
The ARN of the runtime and any errors that occured.static Class
<? extends FunctionConfiguration.Builder> final String
The ARN of the signing job.final String
The ARN of the signing profile version.final SnapStartResponse
SetApplyOn
toPublishedVersions
to create a snapshot of the initialized execution environment when you publish a function version.final State
state()
The current state of the function.final String
The current state of the function.final String
The reason for the function's current state.final StateReasonCode
The reason code for the function's current state.final String
The reason code for the function's current state.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 TracingConfigResponse
The function's X-Ray tracing configuration.final String
version()
The version of the Lambda function.final VpcConfigResponse
The function's networking configuration.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
functionName
The name of the function.
- Returns:
- The name of the function.
-
functionArn
The function's Amazon Resource Name (ARN).
- Returns:
- The function's Amazon Resource Name (ARN).
-
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:
-
role
The function's execution role.
- Returns:
- The function's execution role.
-
handler
The function that Lambda calls to begin running your function.
- Returns:
- The function that Lambda calls to begin running your function.
-
codeSize
The size of the function's deployment package, in bytes.
- Returns:
- The size of the function's deployment package, in bytes.
-
description
The function's description.
- Returns:
- The function's description.
-
timeout
The amount of time in seconds that Lambda allows a function to run before stopping it.
- Returns:
- The amount of time in seconds that Lambda allows a function to run before stopping it.
-
memorySize
The amount of memory available to the function at runtime.
- Returns:
- The amount of memory available to the function at runtime.
-
lastModified
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- Returns:
- The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
-
codeSha256
The SHA256 hash of the function's deployment package.
- Returns:
- The SHA256 hash of the function's deployment package.
-
version
The version of the Lambda function.
- Returns:
- The version of the Lambda function.
-
vpcConfig
The function's networking configuration.
- Returns:
- The function's networking configuration.
-
deadLetterConfig
The function's dead letter queue.
- Returns:
- The function's dead letter queue.
-
environment
The function's environment variables. Omitted from CloudTrail logs.
- Returns:
- The function's environment variables. Omitted from CloudTrail logs.
-
kmsKeyArn
The KMS key that's used to encrypt the function's environment variables. When Lambda SnapStart is activated, this key is also used to encrypt the function's snapshot. This key is returned only if you've configured a customer managed key.
- Returns:
- The KMS key that's used to encrypt the function's environment variables. When Lambda SnapStart is activated, this key is also used to encrypt the function's snapshot. This key is returned only if you've configured a customer managed key.
-
tracingConfig
The function's X-Ray tracing configuration.
- Returns:
- The function's X-Ray tracing configuration.
-
masterArn
For Lambda@Edge functions, the ARN of the main function.
- Returns:
- For Lambda@Edge functions, the ARN of the main function.
-
revisionId
The latest updated revision of the function or alias.
- Returns:
- The latest updated revision of the function or alias.
-
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
The function's layers.
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:
- The function's layers.
-
state
The current state of the function. When the state is
Inactive
, you can reactivate the function by invoking it.If the service returns an enum value that is not available in the current SDK version,
state
will returnState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the function. When the state is
Inactive
, you can reactivate the function by invoking it. - See Also:
-
stateAsString
The current state of the function. When the state is
Inactive
, you can reactivate the function by invoking it.If the service returns an enum value that is not available in the current SDK version,
state
will returnState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the function. When the state is
Inactive
, you can reactivate the function by invoking it. - See Also:
-
stateReason
The reason for the function's current state.
- Returns:
- The reason for the function's current state.
-
stateReasonCode
The reason code for the function's current state. When the code is
Creating
, you can't invoke or modify the function.If the service returns an enum value that is not available in the current SDK version,
stateReasonCode
will returnStateReasonCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateReasonCodeAsString()
.- Returns:
- The reason code for the function's current state. When the code is
Creating
, you can't invoke or modify the function. - See Also:
-
stateReasonCodeAsString
The reason code for the function's current state. When the code is
Creating
, you can't invoke or modify the function.If the service returns an enum value that is not available in the current SDK version,
stateReasonCode
will returnStateReasonCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateReasonCodeAsString()
.- Returns:
- The reason code for the function's current state. When the code is
Creating
, you can't invoke or modify the function. - See Also:
-
lastUpdateStatus
The status of the last update that was performed on the function. This is first set to
Successful
after function creation completes.If the service returns an enum value that is not available in the current SDK version,
lastUpdateStatus
will returnLastUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlastUpdateStatusAsString()
.- Returns:
- The status of the last update that was performed on the function. This is first set to
Successful
after function creation completes. - See Also:
-
lastUpdateStatusAsString
The status of the last update that was performed on the function. This is first set to
Successful
after function creation completes.If the service returns an enum value that is not available in the current SDK version,
lastUpdateStatus
will returnLastUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlastUpdateStatusAsString()
.- Returns:
- The status of the last update that was performed on the function. This is first set to
Successful
after function creation completes. - See Also:
-
lastUpdateStatusReason
The reason for the last update that was performed on the function.
- Returns:
- The reason for the last update that was performed on the function.
-
lastUpdateStatusReasonCode
The reason code for the last update that was performed on the function.
If the service returns an enum value that is not available in the current SDK version,
lastUpdateStatusReasonCode
will returnLastUpdateStatusReasonCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlastUpdateStatusReasonCodeAsString()
.- Returns:
- The reason code for the last update that was performed on the function.
- See Also:
-
lastUpdateStatusReasonCodeAsString
The reason code for the last update that was performed on the function.
If the service returns an enum value that is not available in the current SDK version,
lastUpdateStatusReasonCode
will returnLastUpdateStatusReasonCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlastUpdateStatusReasonCodeAsString()
.- Returns:
- The reason code for the last update that was performed on the function.
- See Also:
-
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.
-
packageType
The type of deployment package. Set to
Image
for container image and setZip
for .zip file archive.If the service returns an enum value that is not available in the current SDK version,
packageType
will returnPackageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompackageTypeAsString()
.- Returns:
- The type of deployment package. Set to
Image
for container image and setZip
for .zip file archive. - See Also:
-
packageTypeAsString
The type of deployment package. Set to
Image
for container image and setZip
for .zip file archive.If the service returns an enum value that is not available in the current SDK version,
packageType
will returnPackageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompackageTypeAsString()
.- Returns:
- The type of deployment package. Set to
Image
for container image and setZip
for .zip file archive. - See Also:
-
imageConfigResponse
The function's image configuration values.
- Returns:
- The function's image configuration values.
-
signingProfileVersionArn
The ARN of the signing profile version.
- Returns:
- The ARN of the signing profile version.
-
signingJobArn
The ARN of the signing job.
- Returns:
- The ARN of the signing job.
-
architectures
The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is
x86_64
.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
hasArchitectures()
method.- Returns:
- The instruction set architecture that the function supports. Architecture is a string array with one of
the valid values. The default architecture value is
x86_64
.
-
hasArchitectures
public final boolean hasArchitectures()For responses, this returns true if the service returned a value for the Architectures 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. -
architecturesAsStrings
The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is
x86_64
.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
hasArchitectures()
method.- Returns:
- The instruction set architecture that the function supports. Architecture is a string array with one of
the valid values. The default architecture value is
x86_64
.
-
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
Set
ApplyOn
toPublishedVersions
to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.- Returns:
- Set
ApplyOn
toPublishedVersions
to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.
-
runtimeVersionConfig
The ARN of the runtime and any errors that occured.
- Returns:
- The ARN of the runtime and any errors that occured.
-
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<FunctionConfiguration.Builder,
FunctionConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-