class Amazonite::Lambda::FunctionConfiguration

Overview

Details about a function's configuration.

Included Modules

Defined in:

lambda/function_configuration.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def architectures : Array(Architecture) | Nil #

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.


[View source]
def architectures=(architectures : Array(Architecture) | Nil) #

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.


[View source]
def capacity_provider_config : CapacityProviderConfig | Nil #

Configuration for the capacity provider that manages compute resources for Lambda functions.


[View source]
def capacity_provider_config=(capacity_provider_config : CapacityProviderConfig | Nil) #

Configuration for the capacity provider that manages compute resources for Lambda functions.


[View source]
def code_sha_256 : String | Nil #

The SHA256 hash of the function's deployment package.


[View source]
def code_sha_256=(code_sha_256 : String | Nil) #

The SHA256 hash of the function's deployment package.


[View source]
def code_size : Int64 | Nil #

The size of the function's deployment package, in bytes.


[View source]
def code_size=(code_size : Int64 | Nil) #

The size of the function's deployment package, in bytes.


[View source]
def config_sha_256 : String | Nil #

The SHA256 hash of the function configuration.


[View source]
def config_sha_256=(config_sha_256 : String | Nil) #

The SHA256 hash of the function configuration.


[View source]
def dead_letter_config : DeadLetterConfig | Nil #

The function's dead letter queue.


[View source]
def dead_letter_config=(dead_letter_config : DeadLetterConfig | Nil) #

The function's dead letter queue.


[View source]
def description : String | Nil #

The function's description.


[View source]
def description=(description : String | Nil) #

The function's description.


[View source]
def durable_config : DurableConfig | Nil #

The function's durable execution configuration settings, if the function is configured for durability.


[View source]
def durable_config=(durable_config : DurableConfig | Nil) #

The function's durable execution configuration settings, if the function is configured for durability.


[View source]
def environment : EnvironmentResponse | Nil #

The function's environment variables. Omitted from CloudTrail logs.


[View source]
def environment=(environment : EnvironmentResponse | Nil) #

The function's environment variables. Omitted from CloudTrail logs.


[View source]
def ephemeral_storage : EphemeralStorage | Nil #

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).


[View source]
def ephemeral_storage=(ephemeral_storage : EphemeralStorage | Nil) #

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).


[View source]
def file_system_configs : Array(FileSystemConfig) | Nil #

Connection settings for an Amazon EFS file system or an Amazon S3 file system.


[View source]
def file_system_configs=(file_system_configs : Array(FileSystemConfig) | Nil) #

Connection settings for an Amazon EFS file system or an Amazon S3 file system.


[View source]
def function_arn : String | Nil #

The function's Amazon Resource Name (ARN).


[View source]
def function_arn=(function_arn : String | Nil) #

The function's Amazon Resource Name (ARN).


[View source]
def function_name : String | Nil #

The name of the function.


[View source]
def function_name=(function_name : String | Nil) #

The name of the function.


[View source]
def handler : String | Nil #

The function that Lambda calls to begin running your function.


[View source]
def handler=(handler : String | Nil) #

The function that Lambda calls to begin running your function.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def image_config_response : ImageConfigResponse | Nil #

The function's image configuration values.


[View source]
def image_config_response=(image_config_response : ImageConfigResponse | Nil) #

The function's image configuration values.


[View source]
def kms_key_arn : String | Nil #

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.


[View source]
def 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:

  • 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.


[View source]
def last_modified : String | Nil #

The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).


[View source]
def 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).


[View source]
def last_update_status : LastUpdateStatus | Nil #

The status of the last update that was performed on the function. This is first set to Successful after function creation completes.


[View source]
def last_update_status=(last_update_status : LastUpdateStatus | Nil) #

The status of the last update that was performed on the function. This is first set to Successful after function creation completes.


[View source]
def last_update_status_reason : String | Nil #

The reason for the last update that was performed on the function.


[View source]
def last_update_status_reason=(last_update_status_reason : String | Nil) #

The reason for the last update that was performed on the function.


[View source]
def last_update_status_reason_code : LastUpdateStatusReasonCode | Nil #

The reason code for the last update that was performed on the function.


[View source]
def 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.


[View source]
def layers : Array(Layer) | Nil #

The function's layers.


[View source]
def layers=(layers : Array(Layer) | Nil) #

The function's layers.


[View source]
def logging_config : LoggingConfig | Nil #

The function's Amazon CloudWatch Logs configuration settings.


[View source]
def logging_config=(logging_config : LoggingConfig | Nil) #

The function's Amazon CloudWatch Logs configuration settings.


[View source]
def master_arn : String | Nil #

For Lambda@Edge functions, the ARN of the main function.


[View source]
def master_arn=(master_arn : String | Nil) #

For Lambda@Edge functions, the ARN of the main function.


[View source]
def memory_size : Int32 | Nil #

The amount of memory available to the function at runtime.


[View source]
def memory_size=(memory_size : Int32 | Nil) #

The amount of memory available to the function at runtime.


[View source]
def package_type : PackageType | Nil #

The type of deployment package. Set to Image for container image and set Zip for .zip file archive.


[View source]
def package_type=(package_type : PackageType | Nil) #

The type of deployment package. Set to Image for container image and set Zip for .zip file archive.


[View source]
def revision_id : String | Nil #

The latest updated revision of the function or alias.


[View source]
def revision_id=(revision_id : String | Nil) #

The latest updated revision of the function or alias.


[View source]
def role : String | Nil #

The function's execution role.


[View source]
def role=(role : String | Nil) #

The function's execution role.


[View source]
def runtime : Runtime | Nil #

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.


[View source]
def runtime=(runtime : Runtime | Nil) #

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.


[View source]
def runtime_version_config : RuntimeVersionConfig | Nil #

The ARN of the runtime and any errors that occured.


[View source]
def runtime_version_config=(runtime_version_config : RuntimeVersionConfig | Nil) #

The ARN of the runtime and any errors that occured.


[View source]
def signing_job_arn : String | Nil #

The ARN of the signing job.


[View source]
def signing_job_arn=(signing_job_arn : String | Nil) #

The ARN of the signing job.


[View source]
def signing_profile_version_arn : String | Nil #

The ARN of the signing profile version.


[View source]
def signing_profile_version_arn=(signing_profile_version_arn : String | Nil) #

The ARN of the signing profile version.


[View source]
def snap_start : SnapStartResponse | Nil #

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.


[View source]
def snap_start=(snap_start : SnapStartResponse | Nil) #

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.


[View source]
def state : State | Nil #

The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.


[View source]
def state=(state : State | Nil) #

The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.


[View source]
def state_reason : String | Nil #

The reason for the function's current state.


[View source]
def state_reason=(state_reason : String | Nil) #

The reason for the function's current state.


[View source]
def state_reason_code : StateReasonCode | Nil #

The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.


[View source]
def state_reason_code=(state_reason_code : StateReasonCode | Nil) #

The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.


[View source]
def tenancy_config : TenancyConfig | Nil #

The function's tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant.


[View source]
def tenancy_config=(tenancy_config : TenancyConfig | Nil) #

The function's tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant.


[View source]
def timeout : Int32 | Nil #

The amount of time in seconds that Lambda allows a function to run before stopping it.


[View source]
def timeout=(timeout : Int32 | Nil) #

The amount of time in seconds that Lambda allows a function to run before stopping it.


[View source]
def tracing_config : TracingConfigResponse | Nil #

The function's X-Ray tracing configuration.


[View source]
def tracing_config=(tracing_config : TracingConfigResponse | Nil) #

The function's X-Ray tracing configuration.


[View source]
def validate! : Nil #

[View source]
def version : String | Nil #

The version of the Lambda function.


[View source]
def version=(version : String | Nil) #

The version of the Lambda function.


[View source]
def vpc_config : VpcConfigResponse | Nil #

The function's networking configuration.


[View source]
def vpc_config=(vpc_config : VpcConfigResponse | Nil) #

The function's networking configuration.


[View source]