Skip to content

FunctionConfiguration

Source code in docs_src/capo_lambda/types/function_configuration.py
class FunctionConfiguration(TypedDict, closed=True):
    function_name: NotRequired[
        "capo_lambda.types.namespaced_function_name.NamespacedFunctionName"
    ]
    """<p>The name of the function.</p>"""
    function_arn: NotRequired[
        "capo_lambda.types.name_spaced_function_arn.NameSpacedFunctionArn"
    ]
    """<p>The function's Amazon Resource Name (ARN).</p>"""
    runtime: NotRequired["capo_lambda.types.runtime.Runtime"]
    """<p>The identifier of the function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html"> runtime</a>. 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.</p> <p>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 <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels">Runtime use after deprecation</a>.</p> <p>For a list of all currently supported runtimes, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported">Supported runtimes</a>.</p>"""
    role: NotRequired["capo_lambda.types.role_arn.RoleArn"]
    """<p>The function's execution role.</p>"""
    handler: NotRequired["capo_lambda.types.handler.Handler"]
    """<p>The function that Lambda calls to begin running your function.</p>"""
    code_size: "capo_lambda.types.long.Long"
    """<p>The size of the function's deployment package, in bytes.</p>"""
    description: NotRequired["capo_lambda.types.description.Description"]
    """<p>The function's description.</p>"""
    timeout: NotRequired["capo_lambda.types.timeout.Timeout"]
    """<p>The amount of time in seconds that Lambda allows a function to run before stopping it.</p>"""
    memory_size: NotRequired["capo_lambda.types.memory_size.MemorySize"]
    """<p>The amount of memory available to the function at runtime.</p>"""
    last_modified: NotRequired["capo_lambda.types.timestamp.Timestamp"]
    """<p>The date and time that the function was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).</p>"""
    code_sha256: NotRequired["capo_lambda.types.string.String"]
    """<p>The SHA256 hash of the function's deployment package.</p>"""
    version: NotRequired["capo_lambda.types.version.Version"]
    """<p>The version of the Lambda function.</p>"""
    vpc_config: NotRequired["capo_lambda.types.vpc_config_response.VpcConfigResponse"]
    """<p>The function's networking configuration.</p>"""
    dead_letter_config: NotRequired[
        "capo_lambda.types.dead_letter_config.DeadLetterConfig"
    ]
    """<p>The function's dead letter queue.</p>"""
    environment: NotRequired[
        "capo_lambda.types.environment_response.EnvironmentResponse"
    ]
    """<p>The function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html">environment variables</a>. Omitted from CloudTrail logs.</p>"""
    kms_key_arn: NotRequired["capo_lambda.types.kms_key_arn.KMSKeyArn"]
    """<p>The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:</p> <ul> <li> <p>The function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption">environment variables</a>.</p> </li> <li> <p>The function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html">Lambda SnapStart</a> snapshots.</p> </li> <li> <p>When used with <code>SourceKMSKeyArn</code>, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/encrypt-zip-package.html#enable-zip-custom-encryption"> Specifying a customer managed key for Lambda</a>.</p> </li> <li> <p>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 <a href="https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-lifecycle">Function lifecycle</a>.</p> </li> </ul> <p>If you don't provide a customer managed key, Lambda uses an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">Amazon Web Services owned key</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.</p>"""
    tracing_config: NotRequired[
        "capo_lambda.types.tracing_config_response.TracingConfigResponse"
    ]
    """<p>The function's X-Ray tracing configuration.</p>"""
    master_arn: NotRequired["capo_lambda.types.function_arn.FunctionArn"]
    """<p>For Lambda@Edge functions, the ARN of the main function.</p>"""
    revision_id: NotRequired["capo_lambda.types.string.String"]
    """<p>The latest updated revision of the function or alias.</p>"""
    layers: NotRequired["capo_lambda.types.layers_reference_list.LayersReferenceList"]
    """<p>The function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html">layers</a>.</p>"""
    state: NotRequired["capo_lambda.types.state.State"]
    """<p>The current state of the function. When the state is <code>Inactive</code>, you can reactivate the function by invoking it.</p>"""
    state_reason: NotRequired["capo_lambda.types.state_reason.StateReason"]
    """<p>The reason for the function's current state.</p>"""
    state_reason_code: NotRequired[
        "capo_lambda.types.state_reason_code.StateReasonCode"
    ]
    """<p>The reason code for the function's current state. When the code is <code>Creating</code>, you can't invoke or modify the function.</p>"""
    last_update_status: NotRequired[
        "capo_lambda.types.last_update_status.LastUpdateStatus"
    ]
    """<p>The status of the last update that was performed on the function. This is first set to <code>Successful</code> after function creation completes.</p>"""
    last_update_status_reason: NotRequired[
        "capo_lambda.types.last_update_status_reason.LastUpdateStatusReason"
    ]
    """<p>The reason for the last update that was performed on the function.</p>"""
    last_update_status_reason_code: NotRequired[
        "capo_lambda.types.last_update_status_reason_code.LastUpdateStatusReasonCode"
    ]
    """<p>The reason code for the last update that was performed on the function.</p>"""
    file_system_configs: NotRequired[
        "capo_lambda.types.file_system_config_list.FileSystemConfigList"
    ]
    """<p>Connection settings for an <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html">Amazon EFS file system</a> or an <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html">Amazon S3 file system</a>.</p>"""
    signing_profile_version_arn: NotRequired["capo_lambda.types.arn.Arn"]
    """<p>The ARN of the signing profile version.</p>"""
    signing_job_arn: NotRequired["capo_lambda.types.arn.Arn"]
    """<p>The ARN of the signing job.</p>"""
    package_type: NotRequired["capo_lambda.types.package_type.PackageType"]
    """<p>The type of deployment package. Set to <code>Image</code> for container image and set <code>Zip</code> for .zip file archive.</p>"""
    image_config_response: NotRequired[
        "capo_lambda.types.image_config_response.ImageConfigResponse"
    ]
    """<p>The function's image configuration values.</p>"""
    architectures: NotRequired["capo_lambda.types.architectures_list.ArchitecturesList"]
    """<p>The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is <code>x86_64</code>.</p>"""
    ephemeral_storage: NotRequired[
        "capo_lambda.types.ephemeral_storage.EphemeralStorage"
    ]
    """<p>The size of the function's <code>/tmp</code> directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage">Configuring ephemeral storage (console)</a>.</p>"""
    snap_start: NotRequired["capo_lambda.types.snap_start_response.SnapStartResponse"]
    """<p>Set <code>ApplyOn</code> to <code>PublishedVersions</code> to create a snapshot of the initialized execution environment when you publish a function version. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html">Improving startup performance with Lambda SnapStart</a>.</p>"""
    runtime_version_config: NotRequired[
        "capo_lambda.types.runtime_version_config.RuntimeVersionConfig"
    ]
    """<p>The ARN of the runtime and any errors that occured.</p>"""
    logging_config: NotRequired["capo_lambda.types.logging_config.LoggingConfig"]
    """<p>The function's Amazon CloudWatch Logs configuration settings.</p>"""
    tenancy_config: NotRequired["capo_lambda.types.tenancy_config.TenancyConfig"]
    """<p>The function's tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant.</p>"""
    capacity_provider_config: NotRequired[
        "capo_lambda.types.capacity_provider_config.CapacityProviderConfig"
    ]
    """<p>Configuration for the capacity provider that manages compute resources for Lambda functions.</p>"""
    config_sha256: NotRequired["capo_lambda.types.string.String"]
    """<p>The SHA256 hash of the function configuration.</p>"""
    durable_config: NotRequired["capo_lambda.types.durable_config.DurableConfig"]
    """<p>The function's durable execution configuration settings, if the function is configured for durability.</p>"""

architectures instance-attribute

architectures: NotRequired[ArchitecturesList]

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.

capacity_provider_config instance-attribute

capacity_provider_config: NotRequired[CapacityProviderConfig]

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

code_sha256 instance-attribute

code_sha256: NotRequired[String]

The SHA256 hash of the function's deployment package.

code_size instance-attribute

code_size: Long

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

config_sha256 instance-attribute

config_sha256: NotRequired[String]

The SHA256 hash of the function configuration.

dead_letter_config instance-attribute

dead_letter_config: NotRequired[DeadLetterConfig]

The function's dead letter queue.

description instance-attribute

description: NotRequired[Description]

The function's description.

durable_config instance-attribute

durable_config: NotRequired[DurableConfig]

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

environment instance-attribute

environment: NotRequired[EnvironmentResponse]

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

ephemeral_storage instance-attribute

ephemeral_storage: NotRequired[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).

file_system_configs instance-attribute

file_system_configs: NotRequired[FileSystemConfigList]

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

function_arn instance-attribute

function_arn: NotRequired[NameSpacedFunctionArn]

The function's Amazon Resource Name (ARN).

function_name instance-attribute

function_name: NotRequired[NamespacedFunctionName]

The name of the function.

handler instance-attribute

handler: NotRequired[Handler]

The function that Lambda calls to begin running your function.

image_config_response instance-attribute

image_config_response: NotRequired[ImageConfigResponse]

The function's image configuration values.

kms_key_arn instance-attribute

kms_key_arn: NotRequired[KMSKeyArn]

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.

last_modified instance-attribute

last_modified: NotRequired[Timestamp]

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

last_update_status instance-attribute

last_update_status: NotRequired[LastUpdateStatus]

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

last_update_status_reason instance-attribute

last_update_status_reason: NotRequired[LastUpdateStatusReason]

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

last_update_status_reason_code instance-attribute

last_update_status_reason_code: NotRequired[LastUpdateStatusReasonCode]

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

layers instance-attribute

layers: NotRequired[LayersReferenceList]

The function's layers.

logging_config instance-attribute

logging_config: NotRequired[LoggingConfig]

The function's Amazon CloudWatch Logs configuration settings.

master_arn instance-attribute

master_arn: NotRequired[FunctionArn]

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

memory_size instance-attribute

memory_size: NotRequired[MemorySize]

The amount of memory available to the function at runtime.

package_type instance-attribute

package_type: NotRequired[PackageType]

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

revision_id instance-attribute

revision_id: NotRequired[String]

The latest updated revision of the function or alias.

role instance-attribute

role: NotRequired[RoleArn]

The function's execution role.

runtime instance-attribute

runtime: NotRequired[Runtime]

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.

runtime_version_config instance-attribute

runtime_version_config: NotRequired[RuntimeVersionConfig]

The ARN of the runtime and any errors that occured.

signing_job_arn instance-attribute

signing_job_arn: NotRequired[Arn]

The ARN of the signing job.

signing_profile_version_arn instance-attribute

signing_profile_version_arn: NotRequired[Arn]

The ARN of the signing profile version.

snap_start instance-attribute

snap_start: NotRequired[SnapStartResponse]

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.

state instance-attribute

state: NotRequired[State]

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

state_reason instance-attribute

state_reason: NotRequired[StateReason]

The reason for the function's current state.

state_reason_code instance-attribute

state_reason_code: NotRequired[StateReasonCode]

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

tenancy_config instance-attribute

tenancy_config: NotRequired[TenancyConfig]

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

timeout instance-attribute

timeout: NotRequired[Timeout]

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

tracing_config instance-attribute

tracing_config: NotRequired[TracingConfigResponse]

The function's X-Ray tracing configuration.

version instance-attribute

version: NotRequired[Version]

The version of the Lambda function.

vpc_config instance-attribute

vpc_config: NotRequired[VpcConfigResponse]

The function's networking configuration.