class
Amazonite::Lambda::FunctionConfiguration
- Amazonite::Lambda::FunctionConfiguration
- Reference
- Object
Overview
Details about a function's configuration.
Included Modules
- JSON::Serializable
Defined in:
lambda/function_configuration.crConstructors
- .new(pull : JSON::PullParser)
- .new(function_name : String | Nil = nil, function_arn : String | Nil = nil, runtime : Runtime | Nil = nil, role : String | Nil = nil, handler : String | Nil = nil, code_size : Int64 | Nil = nil, description : String | Nil = nil, timeout : Int32 | Nil = nil, memory_size : Int32 | Nil = nil, last_modified : String | Nil = nil, code_sha_256 : String | Nil = nil, version : String | Nil = nil, vpc_config : VpcConfigResponse | Nil = nil, dead_letter_config : DeadLetterConfig | Nil = nil, environment : EnvironmentResponse | Nil = nil, kms_key_arn : String | Nil = nil, tracing_config : TracingConfigResponse | Nil = nil, master_arn : String | Nil = nil, revision_id : String | Nil = nil, layers : Array(Layer) | Nil = nil, state : State | Nil = nil, state_reason : String | Nil = nil, state_reason_code : StateReasonCode | Nil = nil, last_update_status : LastUpdateStatus | Nil = nil, last_update_status_reason : String | Nil = nil, last_update_status_reason_code : LastUpdateStatusReasonCode | Nil = nil, file_system_configs : Array(FileSystemConfig) | Nil = nil, signing_profile_version_arn : String | Nil = nil, signing_job_arn : String | Nil = nil, package_type : PackageType | Nil = nil, image_config_response : ImageConfigResponse | Nil = nil, architectures : Array(Architecture) | Nil = nil, ephemeral_storage : EphemeralStorage | Nil = nil, snap_start : SnapStartResponse | Nil = nil, runtime_version_config : RuntimeVersionConfig | Nil = nil, logging_config : LoggingConfig | Nil = nil, tenancy_config : TenancyConfig | Nil = nil, capacity_provider_config : CapacityProviderConfig | Nil = nil, config_sha_256 : String | Nil = nil, durable_config : DurableConfig | Nil = nil)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#architectures : Array(Architecture) | Nil
The instruction set architecture that the function supports.
-
#architectures=(architectures : Array(Architecture) | Nil)
The instruction set architecture that the function supports.
-
#capacity_provider_config : CapacityProviderConfig | Nil
Configuration for the capacity provider that manages compute resources for Lambda functions.
-
#capacity_provider_config=(capacity_provider_config : CapacityProviderConfig | Nil)
Configuration for the capacity provider that manages compute resources for Lambda functions.
-
#code_sha_256 : String | Nil
The SHA256 hash of the function's deployment package.
-
#code_sha_256=(code_sha_256 : String | Nil)
The SHA256 hash of the function's deployment package.
-
#code_size : Int64 | Nil
The size of the function's deployment package, in bytes.
-
#code_size=(code_size : Int64 | Nil)
The size of the function's deployment package, in bytes.
-
#config_sha_256 : String | Nil
The SHA256 hash of the function configuration.
-
#config_sha_256=(config_sha_256 : String | Nil)
The SHA256 hash of the function configuration.
-
#dead_letter_config : DeadLetterConfig | Nil
The function's dead letter queue.
-
#dead_letter_config=(dead_letter_config : DeadLetterConfig | Nil)
The function's dead letter queue.
-
#description : String | Nil
The function's description.
-
#description=(description : String | Nil)
The function's description.
-
#durable_config : DurableConfig | Nil
The function's durable execution configuration settings, if the function is configured for durability.
-
#durable_config=(durable_config : DurableConfig | Nil)
The function's durable execution configuration settings, if the function is configured for durability.
-
#environment : EnvironmentResponse | Nil
The function's environment variables.
-
#environment=(environment : EnvironmentResponse | Nil)
The function's environment variables.
-
#ephemeral_storage : EphemeralStorage | Nil
The size of the function's
/tmpdirectory in MB. -
#ephemeral_storage=(ephemeral_storage : EphemeralStorage | Nil)
The size of the function's
/tmpdirectory in MB. -
#file_system_configs : Array(FileSystemConfig) | Nil
Connection settings for an Amazon EFS file system or an Amazon S3 file system.
-
#file_system_configs=(file_system_configs : Array(FileSystemConfig) | Nil)
Connection settings for an Amazon EFS file system or an Amazon S3 file system.
-
#function_arn : String | Nil
The function's Amazon Resource Name (ARN).
-
#function_arn=(function_arn : String | Nil)
The function's Amazon Resource Name (ARN).
-
#function_name : String | Nil
The name of the function.
-
#function_name=(function_name : String | Nil)
The name of the function.
-
#handler : String | Nil
The function that Lambda calls to begin running your function.
-
#handler=(handler : String | Nil)
The function that Lambda calls to begin running your function.
-
#hash(hasher)
See
Object#hash(hasher) -
#image_config_response : ImageConfigResponse | Nil
The function's image configuration values.
-
#image_config_response=(image_config_response : ImageConfigResponse | Nil)
The function's image configuration values.
-
#kms_key_arn : String | Nil
The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:
-
#kms_key_arn=(kms_key_arn : String | Nil)
The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:
-
#last_modified : String | Nil
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
-
#last_modified=(last_modified : String | Nil)
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
-
#last_update_status : LastUpdateStatus | Nil
The status of the last update that was performed on the function.
-
#last_update_status=(last_update_status : LastUpdateStatus | Nil)
The status of the last update that was performed on the function.
-
#last_update_status_reason : String | Nil
The reason for the last update that was performed on the function.
-
#last_update_status_reason=(last_update_status_reason : String | Nil)
The reason for the last update that was performed on the function.
-
#last_update_status_reason_code : LastUpdateStatusReasonCode | Nil
The reason code for the last update that was performed on the function.
-
#last_update_status_reason_code=(last_update_status_reason_code : LastUpdateStatusReasonCode | Nil)
The reason code for the last update that was performed on the function.
-
#layers : Array(Layer) | Nil
The function's layers.
-
#layers=(layers : Array(Layer) | Nil)
The function's layers.
-
#logging_config : LoggingConfig | Nil
The function's Amazon CloudWatch Logs configuration settings.
-
#logging_config=(logging_config : LoggingConfig | Nil)
The function's Amazon CloudWatch Logs configuration settings.
-
#master_arn : String | Nil
For Lambda@Edge functions, the ARN of the main function.
-
#master_arn=(master_arn : String | Nil)
For Lambda@Edge functions, the ARN of the main function.
-
#memory_size : Int32 | Nil
The amount of memory available to the function at runtime.
-
#memory_size=(memory_size : Int32 | Nil)
The amount of memory available to the function at runtime.
-
#package_type : PackageType | Nil
The type of deployment package.
-
#package_type=(package_type : PackageType | Nil)
The type of deployment package.
-
#revision_id : String | Nil
The latest updated revision of the function or alias.
-
#revision_id=(revision_id : String | Nil)
The latest updated revision of the function or alias.
-
#role : String | Nil
The function's execution role.
-
#role=(role : String | Nil)
The function's execution role.
-
#runtime : Runtime | Nil
The identifier of the function's runtime.
-
#runtime=(runtime : Runtime | Nil)
The identifier of the function's runtime.
-
#runtime_version_config : RuntimeVersionConfig | Nil
The ARN of the runtime and any errors that occured.
-
#runtime_version_config=(runtime_version_config : RuntimeVersionConfig | Nil)
The ARN of the runtime and any errors that occured.
-
#signing_job_arn : String | Nil
The ARN of the signing job.
-
#signing_job_arn=(signing_job_arn : String | Nil)
The ARN of the signing job.
-
#signing_profile_version_arn : String | Nil
The ARN of the signing profile version.
-
#signing_profile_version_arn=(signing_profile_version_arn : String | Nil)
The ARN of the signing profile version.
-
#snap_start : SnapStartResponse | Nil
Set
ApplyOntoPublishedVersionsto create a snapshot of the initialized execution environment when you publish a function version. -
#snap_start=(snap_start : SnapStartResponse | Nil)
Set
ApplyOntoPublishedVersionsto create a snapshot of the initialized execution environment when you publish a function version. -
#state : State | Nil
The current state of the function.
-
#state=(state : State | Nil)
The current state of the function.
-
#state_reason : String | Nil
The reason for the function's current state.
-
#state_reason=(state_reason : String | Nil)
The reason for the function's current state.
-
#state_reason_code : StateReasonCode | Nil
The reason code for the function's current state.
-
#state_reason_code=(state_reason_code : StateReasonCode | Nil)
The reason code for the function's current state.
-
#tenancy_config : TenancyConfig | Nil
The function's tenant isolation configuration settings.
-
#tenancy_config=(tenancy_config : TenancyConfig | Nil)
The function's tenant isolation configuration settings.
-
#timeout : Int32 | Nil
The amount of time in seconds that Lambda allows a function to run before stopping it.
-
#timeout=(timeout : Int32 | Nil)
The amount of time in seconds that Lambda allows a function to run before stopping it.
-
#tracing_config : TracingConfigResponse | Nil
The function's X-Ray tracing configuration.
-
#tracing_config=(tracing_config : TracingConfigResponse | Nil)
The function's X-Ray tracing configuration.
- #validate! : Nil
-
#version : String | Nil
The version of the Lambda function.
-
#version=(version : String | Nil)
The version of the Lambda function.
-
#vpc_config : VpcConfigResponse | Nil
The function's networking configuration.
-
#vpc_config=(vpc_config : VpcConfigResponse | Nil)
The function's networking configuration.
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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.
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.
Configuration for the capacity provider that manages compute resources for Lambda functions.
Configuration for the capacity provider that manages compute resources for Lambda functions.
The SHA256 hash of the function's deployment package.
The function's dead letter queue.
The function's durable execution configuration settings, if the function is configured for durability.
The function's durable execution configuration settings, if the function is configured for durability.
The function's environment variables. Omitted from CloudTrail logs.
The function's environment variables. Omitted from CloudTrail logs.
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).
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).
Connection settings for an Amazon EFS file system or an Amazon S3 file system.
Connection settings for an Amazon EFS file system or an Amazon S3 file system.
The function that Lambda calls to begin running your function.
The function's image configuration values.
The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:
-
The function's environment variables.
-
The function's Lambda SnapStart snapshots.
-
When used with
SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda. -
The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.
If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.
The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:
-
The function's environment variables.
-
The function's Lambda SnapStart snapshots.
-
When used with
SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda. -
The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.
If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
The status of the last update that was performed on the function. This is first set to
Successful after function creation completes.
The status of the last update that was performed on the function. This is first set to
Successful after function creation completes.
The reason for the last update that was performed on the function.
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.
The reason code for the last update that was performed on the function.
The function's Amazon CloudWatch Logs configuration settings.
The function's Amazon CloudWatch Logs configuration settings.
For Lambda@Edge functions, the ARN of the main function.
The amount of memory available to the function at runtime.
The type of deployment package. Set to Image for container image and set Zip for .zip file
archive.
The type of deployment package. Set to Image for container image and set Zip for .zip file
archive.
The latest updated revision of the function or alias.
The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.
For a list of all currently supported runtimes, see Supported runtimes.
The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.
For a list of all currently supported runtimes, see Supported runtimes.
The ARN of the runtime and any errors that occured.
The ARN of the runtime and any errors that occured.
The ARN of the signing profile version.
Set ApplyOn to PublishedVersions 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.
Set ApplyOn to PublishedVersions 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.
The current state of the function. When the state is Inactive, you can reactivate the function
by invoking it.
The current state of the function. When the state is Inactive, you can reactivate the function
by invoking it.
The reason code for the function's current state. When the code is Creating, you can't invoke
or modify the function.
The reason code for the function's current state. When the code is Creating, you can't invoke
or modify the function.
The function's tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant.
The function's tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant.
The amount of time in seconds that Lambda allows a function to run before stopping it.
The amount of time in seconds that Lambda allows a function to run before stopping it.
The function's X-Ray tracing configuration.