Skip to content

CreateFunctionRequest

Source code in docs_src/capo_lambda/types/create_function_request.py
class CreateFunctionRequest(TypedDict, closed=True):
    function_name: "capo_lambda.types.function_name.FunctionName"
    """<p>The name or ARN of the Lambda function.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> – <code>my-function</code>.</p> </li> <li> <p> <b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p> </li> <li> <p> <b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p> </li> </ul> <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</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: "capo_lambda.types.role_arn.RoleArn"
    """<p>The Amazon Resource Name (ARN) of the function's execution role.</p>"""
    handler: NotRequired["capo_lambda.types.handler.Handler"]
    """<p>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 <a href="https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html">Lambda programming model</a>.</p>"""
    code: "capo_lambda.types.function_code.FunctionCode"
    """<p>The code for the function.</p>"""
    description: NotRequired["capo_lambda.types.description.Description"]
    """<p>A description of the function.</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. The default is 3 seconds, and the maximum allowed value is 900 seconds. For functions using Lambda Managed Instances, asynchronous invocations and event source mapping invocations (except Amazon MQ and Amazon DocumentDB) support a maximum allowed value of 5,400 seconds (90 minutes). For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html">Lambda execution environment</a>.</p>"""
    memory_size: NotRequired["capo_lambda.types.memory_size.MemorySize"]
    """<p>The amount of <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console">memory available to the function</a> 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.</p>"""
    publish: "capo_lambda.types.boolean.Boolean"
    """<p>Set to true to publish the first version of the function during creation.</p>"""
    publish_to: NotRequired[
        "capo_lambda.types.function_version_latest_published.FunctionVersionLatestPublished"
    ]
    """<p>Specifies where to publish the function version or configuration.</p>"""
    vpc_config: NotRequired["capo_lambda.types.vpc_config.VpcConfig"]
    """<p>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 <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html">Configuring a Lambda function to access resources in a VPC</a>.</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 to <code>Zip</code> for .zip file archive.</p>"""
    dead_letter_config: NotRequired[
        "capo_lambda.types.dead_letter_config.DeadLetterConfig"
    ]
    """<p>A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq">Dead-letter queues</a>.</p>"""
    environment: NotRequired["capo_lambda.types.environment.Environment"]
    """<p>Environment variables that are accessible from function code during execution.</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.TracingConfig"]
    """<p>Set <code>Mode</code> to <code>Active</code> to sample and trace a subset of incoming requests with <a href="https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html">X-Ray</a>.</p>"""
    tags: NotRequired["capo_lambda.types.tags.Tags"]
    """<p>A list of <a href="https://docs.aws.amazon.com/lambda/latest/dg/tagging.html">tags</a> to apply to the function.</p>"""
    layers: NotRequired["capo_lambda.types.layer_list.LayerList"]
    """<p>A list of <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html">function layers</a> to add to the function's execution environment. Specify each layer by its ARN, including the version.</p>"""
    file_system_configs: NotRequired[
        "capo_lambda.types.file_system_config_list.FileSystemConfigList"
    ]
    """<p>Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.</p>"""
    code_signing_config_arn: NotRequired[
        "capo_lambda.types.code_signing_config_arn.CodeSigningConfigArn"
    ]
    """<p>To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.</p>"""
    image_config: NotRequired["capo_lambda.types.image_config.ImageConfig"]
    """<p>Container image <a href="https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms">configuration values</a> that override the values in the container image Dockerfile.</p>"""
    architectures: NotRequired["capo_lambda.types.architectures_list.ArchitecturesList"]
    """<p>The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default 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.SnapStart"]
    """<p>The function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html">SnapStart</a> setting.</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>Configuration for multi-tenant applications that use Lambda functions. Defines tenant isolation settings and resource allocations. Required for functions supporting multiple tenants.</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>"""
    durable_config: NotRequired["capo_lambda.types.durable_config.DurableConfig"]
    """<p>Configuration settings for durable functions. Enables creating functions with durability that can remember their state and continue execution even after interruptions.</p>"""

architectures instance-attribute

architectures: NotRequired[ArchitecturesList]

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default 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 instance-attribute

The code for the function.

code_signing_config_arn instance-attribute

code_signing_config_arn: NotRequired[CodeSigningConfigArn]

To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

dead_letter_config instance-attribute

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

description instance-attribute

description: NotRequired[Description]

A description of the function.

durable_config instance-attribute

durable_config: NotRequired[DurableConfig]

Configuration settings for durable functions. Enables creating functions with durability that can remember their state and continue execution even after interruptions.

environment instance-attribute

environment: NotRequired[Environment]

Environment variables that are accessible from function code during execution.

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 Files file system.

function_name instance-attribute

function_name: 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.

handler instance-attribute

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

image_config instance-attribute

image_config: NotRequired[ImageConfig]

Container image configuration values that override the values in the container image Dockerfile.

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.

layers instance-attribute

layers: NotRequired[LayerList]

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

logging_config instance-attribute

logging_config: NotRequired[LoggingConfig]

The function's Amazon CloudWatch Logs configuration settings.

memory_size instance-attribute

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

package_type instance-attribute

package_type: NotRequired[PackageType]

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

publish instance-attribute

publish: Boolean

Set to true to publish the first version of the function during creation.

publish_to instance-attribute

publish_to: NotRequired[FunctionVersionLatestPublished]

Specifies where to publish the function version or configuration.

role instance-attribute

role: RoleArn

The Amazon Resource Name (ARN) of 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.

snap_start instance-attribute

snap_start: NotRequired[SnapStart]

The function's SnapStart setting.

tags instance-attribute

tags: NotRequired[Tags]

A list of tags to apply to the function.

tenancy_config instance-attribute

tenancy_config: NotRequired[TenancyConfig]

Configuration for multi-tenant applications that use Lambda functions. Defines tenant isolation settings and resource allocations. Required for functions supporting multiple tenants.

timeout instance-attribute

timeout: NotRequired[Timeout]

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds, and the maximum allowed value is 900 seconds. For functions using Lambda Managed Instances, asynchronous invocations and event source mapping invocations (except Amazon MQ and Amazon DocumentDB) support a maximum allowed value of 5,400 seconds (90 minutes). For more information, see Lambda execution environment.

tracing_config instance-attribute

tracing_config: NotRequired[TracingConfig]

Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

vpc_config instance-attribute

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