1. Packages
  2. AWS Native
  3. API Docs
  4. lambda
  5. getFunction

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.lambda.getFunction

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    The AWS::Lambda::Function resource creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing. You set the package type to Image if the deployment package is a container image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties. You set the package type to Zip if the deployment package is a .zip file archive. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see Deploy Python Lambda functions with .zip file archives. You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function. Note that you configure provisioned concurrency on a AWS::Lambda::Version or a AWS::Lambda::Alias. For a complete introduction to Lambda functions, see What is Lambda? in the Lambda developer guide.

    Using getFunction

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFunction(args: GetFunctionArgs, opts?: InvokeOptions): Promise<GetFunctionResult>
    function getFunctionOutput(args: GetFunctionOutputArgs, opts?: InvokeOptions): Output<GetFunctionResult>
    def get_function(function_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetFunctionResult
    def get_function_output(function_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetFunctionResult]
    func LookupFunction(ctx *Context, args *LookupFunctionArgs, opts ...InvokeOption) (*LookupFunctionResult, error)
    func LookupFunctionOutput(ctx *Context, args *LookupFunctionOutputArgs, opts ...InvokeOption) LookupFunctionResultOutput

    > Note: This function is named LookupFunction in the Go SDK.

    public static class GetFunction 
    {
        public static Task<GetFunctionResult> InvokeAsync(GetFunctionArgs args, InvokeOptions? opts = null)
        public static Output<GetFunctionResult> Invoke(GetFunctionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFunctionResult> getFunction(GetFunctionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:lambda:getFunction
      arguments:
        # arguments dictionary

    The following arguments are supported:

    FunctionName string
    The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
    FunctionName string
    The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
    functionName String
    The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
    functionName string
    The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
    function_name str
    The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
    functionName String
    The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

    getFunction Result

    The following output properties are available:

    Architectures List<Pulumi.AwsNative.Lambda.FunctionArchitecturesItem>
    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.
    Arn string
    CodeSigningConfigArn string
    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.
    DeadLetterConfig Pulumi.AwsNative.Lambda.Outputs.FunctionDeadLetterConfig
    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 string
    A description of the function.
    Environment Pulumi.AwsNative.Lambda.Outputs.FunctionEnvironment
    Environment variables that are accessible from function code during execution.
    EphemeralStorage Pulumi.AwsNative.Lambda.Outputs.FunctionEphemeralStorage
    The size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
    FileSystemConfigs List<Pulumi.AwsNative.Lambda.Outputs.FunctionFileSystemConfig>
    Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function. For more information about using the DependsOn attribute, see DependsOn Attribute.
    Handler string
    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.
    ImageConfig Pulumi.AwsNative.Lambda.Outputs.FunctionImageConfig
    Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.
    KmsKeyArn string
    The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
    Layers List<string>
    A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
    LoggingConfig Pulumi.AwsNative.Lambda.Outputs.FunctionLoggingConfig
    The function's Amazon CloudWatch Logs configuration settings.
    MemorySize int
    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. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
    PackageType Pulumi.AwsNative.Lambda.FunctionPackageType
    The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
    ReservedConcurrentExecutions int
    The number of simultaneous executions to reserve for the function.
    Role string
    The Amazon Resource Name (ARN) of the function's execution role.
    Runtime string
    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.
    RuntimeManagementConfig Pulumi.AwsNative.Lambda.Outputs.FunctionRuntimeManagementConfig
    Sets the runtime management configuration for a function's version. For more information, see Runtime updates.
    SnapStartResponse Pulumi.AwsNative.Lambda.Outputs.FunctionSnapStartResponse
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of tags to apply to the function.
    Timeout int
    The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
    TracingConfig Pulumi.AwsNative.Lambda.Outputs.FunctionTracingConfig
    Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.
    VpcConfig Pulumi.AwsNative.Lambda.Outputs.FunctionVpcConfig
    For network connectivity to AWS 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.
    Architectures []FunctionArchitecturesItem
    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.
    Arn string
    CodeSigningConfigArn string
    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.
    DeadLetterConfig FunctionDeadLetterConfig
    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 string
    A description of the function.
    Environment FunctionEnvironment
    Environment variables that are accessible from function code during execution.
    EphemeralStorage FunctionEphemeralStorage
    The size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
    FileSystemConfigs []FunctionFileSystemConfig
    Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function. For more information about using the DependsOn attribute, see DependsOn Attribute.
    Handler string
    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.
    ImageConfig FunctionImageConfig
    Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.
    KmsKeyArn string
    The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
    Layers []string
    A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
    LoggingConfig FunctionLoggingConfig
    The function's Amazon CloudWatch Logs configuration settings.
    MemorySize int
    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. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
    PackageType FunctionPackageType
    The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
    ReservedConcurrentExecutions int
    The number of simultaneous executions to reserve for the function.
    Role string
    The Amazon Resource Name (ARN) of the function's execution role.
    Runtime string
    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.
    RuntimeManagementConfig FunctionRuntimeManagementConfig
    Sets the runtime management configuration for a function's version. For more information, see Runtime updates.
    SnapStartResponse FunctionSnapStartResponse
    Tags Tag
    A list of tags to apply to the function.
    Timeout int
    The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
    TracingConfig FunctionTracingConfig
    Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.
    VpcConfig FunctionVpcConfig
    For network connectivity to AWS 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.
    architectures List<FunctionArchitecturesItem>
    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.
    arn String
    codeSigningConfigArn String
    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.
    deadLetterConfig FunctionDeadLetterConfig
    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 String
    A description of the function.
    environment FunctionEnvironment
    Environment variables that are accessible from function code during execution.
    ephemeralStorage FunctionEphemeralStorage
    The size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
    fileSystemConfigs List<FunctionFileSystemConfig>
    Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function. For more information about using the DependsOn attribute, see DependsOn Attribute.
    handler String
    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.
    imageConfig FunctionImageConfig
    Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.
    kmsKeyArn String
    The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
    layers List<String>
    A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
    loggingConfig FunctionLoggingConfig
    The function's Amazon CloudWatch Logs configuration settings.
    memorySize Integer
    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. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
    packageType FunctionPackageType
    The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
    reservedConcurrentExecutions Integer
    The number of simultaneous executions to reserve for the function.
    role String
    The Amazon Resource Name (ARN) of the function's execution role.
    runtime String
    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.
    runtimeManagementConfig FunctionRuntimeManagementConfig
    Sets the runtime management configuration for a function's version. For more information, see Runtime updates.
    snapStartResponse FunctionSnapStartResponse
    tags List<Tag>
    A list of tags to apply to the function.
    timeout Integer
    The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
    tracingConfig FunctionTracingConfig
    Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.
    vpcConfig FunctionVpcConfig
    For network connectivity to AWS 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.
    architectures FunctionArchitecturesItem[]
    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.
    arn string
    codeSigningConfigArn string
    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.
    deadLetterConfig FunctionDeadLetterConfig
    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 string
    A description of the function.
    environment FunctionEnvironment
    Environment variables that are accessible from function code during execution.
    ephemeralStorage FunctionEphemeralStorage
    The size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
    fileSystemConfigs FunctionFileSystemConfig[]
    Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function. For more information about using the DependsOn attribute, see DependsOn Attribute.
    handler string
    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.
    imageConfig FunctionImageConfig
    Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.
    kmsKeyArn string
    The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
    layers string[]
    A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
    loggingConfig FunctionLoggingConfig
    The function's Amazon CloudWatch Logs configuration settings.
    memorySize number
    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. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
    packageType FunctionPackageType
    The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
    reservedConcurrentExecutions number
    The number of simultaneous executions to reserve for the function.
    role string
    The Amazon Resource Name (ARN) of the function's execution role.
    runtime string
    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.
    runtimeManagementConfig FunctionRuntimeManagementConfig
    Sets the runtime management configuration for a function's version. For more information, see Runtime updates.
    snapStartResponse FunctionSnapStartResponse
    tags Tag[]
    A list of tags to apply to the function.
    timeout number
    The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
    tracingConfig FunctionTracingConfig
    Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.
    vpcConfig FunctionVpcConfig
    For network connectivity to AWS 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.
    architectures Sequence[lambda_.FunctionArchitecturesItem]
    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.
    arn str
    code_signing_config_arn str
    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 lambda_.FunctionDeadLetterConfig
    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 str
    A description of the function.
    environment lambda_.FunctionEnvironment
    Environment variables that are accessible from function code during execution.
    ephemeral_storage lambda_.FunctionEphemeralStorage
    The size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
    file_system_configs Sequence[lambda_.FunctionFileSystemConfig]
    Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function. For more information about using the DependsOn attribute, see DependsOn Attribute.
    handler str
    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 lambda_.FunctionImageConfig
    Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.
    kms_key_arn str
    The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
    layers Sequence[str]
    A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
    logging_config lambda_.FunctionLoggingConfig
    The function's Amazon CloudWatch Logs configuration settings.
    memory_size int
    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. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
    package_type lambda_.FunctionPackageType
    The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
    reserved_concurrent_executions int
    The number of simultaneous executions to reserve for the function.
    role str
    The Amazon Resource Name (ARN) of the function's execution role.
    runtime str
    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.
    runtime_management_config lambda_.FunctionRuntimeManagementConfig
    Sets the runtime management configuration for a function's version. For more information, see Runtime updates.
    snap_start_response lambda_.FunctionSnapStartResponse
    tags Sequence[root_Tag]
    A list of tags to apply to the function.
    timeout int
    The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
    tracing_config lambda_.FunctionTracingConfig
    Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.
    vpc_config lambda_.FunctionVpcConfig
    For network connectivity to AWS 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.
    architectures List<"x86_64" | "arm64">
    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.
    arn String
    codeSigningConfigArn String
    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.
    deadLetterConfig Property Map
    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 String
    A description of the function.
    environment Property Map
    Environment variables that are accessible from function code during execution.
    ephemeralStorage Property Map
    The size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
    fileSystemConfigs List<Property Map>
    Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function. For more information about using the DependsOn attribute, see DependsOn Attribute.
    handler String
    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.
    imageConfig Property Map
    Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.
    kmsKeyArn String
    The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
    layers List<String>
    A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
    loggingConfig Property Map
    The function's Amazon CloudWatch Logs configuration settings.
    memorySize Number
    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. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
    packageType "Image" | "Zip"
    The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
    reservedConcurrentExecutions Number
    The number of simultaneous executions to reserve for the function.
    role String
    The Amazon Resource Name (ARN) of the function's execution role.
    runtime String
    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.
    runtimeManagementConfig Property Map
    Sets the runtime management configuration for a function's version. For more information, see Runtime updates.
    snapStartResponse Property Map
    tags List<Property Map>
    A list of tags to apply to the function.
    timeout Number
    The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
    tracingConfig Property Map
    Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.
    vpcConfig Property Map
    For network connectivity to AWS 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.

    Supporting Types

    FunctionArchitecturesItem

    FunctionDeadLetterConfig

    TargetArn string
    The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
    TargetArn string
    The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
    targetArn String
    The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
    targetArn string
    The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
    target_arn str
    The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
    targetArn String
    The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

    FunctionEnvironment

    Variables Dictionary<string, string>
    Environment variable key-value pairs. For more information, see Using Lambda environment variables.
    Variables map[string]string
    Environment variable key-value pairs. For more information, see Using Lambda environment variables.
    variables Map<String,String>
    Environment variable key-value pairs. For more information, see Using Lambda environment variables.
    variables {[key: string]: string}
    Environment variable key-value pairs. For more information, see Using Lambda environment variables.
    variables Mapping[str, str]
    Environment variable key-value pairs. For more information, see Using Lambda environment variables.
    variables Map<String>
    Environment variable key-value pairs. For more information, see Using Lambda environment variables.

    FunctionEphemeralStorage

    Size int
    The size of the function's /tmp directory.
    Size int
    The size of the function's /tmp directory.
    size Integer
    The size of the function's /tmp directory.
    size number
    The size of the function's /tmp directory.
    size int
    The size of the function's /tmp directory.
    size Number
    The size of the function's /tmp directory.

    FunctionFileSystemConfig

    Arn string
    The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
    LocalMountPath string
    The path where the function can access the file system, starting with /mnt/.
    Arn string
    The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
    LocalMountPath string
    The path where the function can access the file system, starting with /mnt/.
    arn String
    The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
    localMountPath String
    The path where the function can access the file system, starting with /mnt/.
    arn string
    The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
    localMountPath string
    The path where the function can access the file system, starting with /mnt/.
    arn str
    The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
    local_mount_path str
    The path where the function can access the file system, starting with /mnt/.
    arn String
    The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
    localMountPath String
    The path where the function can access the file system, starting with /mnt/.

    FunctionImageConfig

    Command List<string>
    Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list.
    EntryPoint List<string>
    Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list.
    WorkingDirectory string
    Specifies the working directory. The length of the directory string cannot exceed 1,000 characters.
    Command []string
    Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list.
    EntryPoint []string
    Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list.
    WorkingDirectory string
    Specifies the working directory. The length of the directory string cannot exceed 1,000 characters.
    command List<String>
    Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list.
    entryPoint List<String>
    Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list.
    workingDirectory String
    Specifies the working directory. The length of the directory string cannot exceed 1,000 characters.
    command string[]
    Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list.
    entryPoint string[]
    Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list.
    workingDirectory string
    Specifies the working directory. The length of the directory string cannot exceed 1,000 characters.
    command Sequence[str]
    Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list.
    entry_point Sequence[str]
    Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list.
    working_directory str
    Specifies the working directory. The length of the directory string cannot exceed 1,000 characters.
    command List<String>
    Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list.
    entryPoint List<String>
    Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list.
    workingDirectory String
    Specifies the working directory. The length of the directory string cannot exceed 1,000 characters.

    FunctionLoggingConfig

    ApplicationLogLevel Pulumi.AwsNative.Lambda.FunctionLoggingConfigApplicationLogLevel
    Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.
    LogFormat Pulumi.AwsNative.Lambda.FunctionLoggingConfigLogFormat
    The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.
    LogGroup string
    The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.
    SystemLogLevel Pulumi.AwsNative.Lambda.FunctionLoggingConfigSystemLogLevel
    Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.
    ApplicationLogLevel FunctionLoggingConfigApplicationLogLevel
    Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.
    LogFormat FunctionLoggingConfigLogFormat
    The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.
    LogGroup string
    The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.
    SystemLogLevel FunctionLoggingConfigSystemLogLevel
    Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.
    applicationLogLevel FunctionLoggingConfigApplicationLogLevel
    Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.
    logFormat FunctionLoggingConfigLogFormat
    The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.
    logGroup String
    The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.
    systemLogLevel FunctionLoggingConfigSystemLogLevel
    Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.
    applicationLogLevel FunctionLoggingConfigApplicationLogLevel
    Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.
    logFormat FunctionLoggingConfigLogFormat
    The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.
    logGroup string
    The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.
    systemLogLevel FunctionLoggingConfigSystemLogLevel
    Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.
    application_log_level lambda_.FunctionLoggingConfigApplicationLogLevel
    Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.
    log_format lambda_.FunctionLoggingConfigLogFormat
    The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.
    log_group str
    The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.
    system_log_level lambda_.FunctionLoggingConfigSystemLogLevel
    Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.
    applicationLogLevel "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL"
    Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.
    logFormat "Text" | "JSON"
    The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.
    logGroup String
    The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.
    systemLogLevel "DEBUG" | "INFO" | "WARN"
    Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

    FunctionLoggingConfigApplicationLogLevel

    FunctionLoggingConfigLogFormat

    FunctionLoggingConfigSystemLogLevel

    FunctionPackageType

    FunctionRuntimeManagementConfig

    UpdateRuntimeOn Pulumi.AwsNative.Lambda.FunctionRuntimeManagementConfigUpdateRuntimeOn

    Specify the runtime update mode.

    • Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.
    • FunctionUpdate - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.
    • Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.

    Valid Values: Auto | FunctionUpdate | Manual

    RuntimeVersionArn string
    The ARN of the runtime version you want the function to use. This is only required if you're using the Manual runtime update mode.
    UpdateRuntimeOn FunctionRuntimeManagementConfigUpdateRuntimeOn

    Specify the runtime update mode.

    • Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.
    • FunctionUpdate - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.
    • Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.

    Valid Values: Auto | FunctionUpdate | Manual

    RuntimeVersionArn string
    The ARN of the runtime version you want the function to use. This is only required if you're using the Manual runtime update mode.
    updateRuntimeOn FunctionRuntimeManagementConfigUpdateRuntimeOn

    Specify the runtime update mode.

    • Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.
    • FunctionUpdate - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.
    • Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.

    Valid Values: Auto | FunctionUpdate | Manual

    runtimeVersionArn String
    The ARN of the runtime version you want the function to use. This is only required if you're using the Manual runtime update mode.
    updateRuntimeOn FunctionRuntimeManagementConfigUpdateRuntimeOn

    Specify the runtime update mode.

    • Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.
    • FunctionUpdate - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.
    • Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.

    Valid Values: Auto | FunctionUpdate | Manual

    runtimeVersionArn string
    The ARN of the runtime version you want the function to use. This is only required if you're using the Manual runtime update mode.
    update_runtime_on lambda_.FunctionRuntimeManagementConfigUpdateRuntimeOn

    Specify the runtime update mode.

    • Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.
    • FunctionUpdate - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.
    • Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.

    Valid Values: Auto | FunctionUpdate | Manual

    runtime_version_arn str
    The ARN of the runtime version you want the function to use. This is only required if you're using the Manual runtime update mode.
    updateRuntimeOn "Auto" | "FunctionUpdate" | "Manual"

    Specify the runtime update mode.

    • Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.
    • FunctionUpdate - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.
    • Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.

    Valid Values: Auto | FunctionUpdate | Manual

    runtimeVersionArn String
    The ARN of the runtime version you want the function to use. This is only required if you're using the Manual runtime update mode.

    FunctionRuntimeManagementConfigUpdateRuntimeOn

    FunctionSnapStartResponse

    ApplyOn Pulumi.AwsNative.Lambda.FunctionSnapStartResponseApplyOn
    When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.
    OptimizationStatus Pulumi.AwsNative.Lambda.FunctionSnapStartResponseOptimizationStatus
    When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.
    ApplyOn FunctionSnapStartResponseApplyOn
    When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.
    OptimizationStatus FunctionSnapStartResponseOptimizationStatus
    When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.
    applyOn FunctionSnapStartResponseApplyOn
    When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.
    optimizationStatus FunctionSnapStartResponseOptimizationStatus
    When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.
    applyOn FunctionSnapStartResponseApplyOn
    When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.
    optimizationStatus FunctionSnapStartResponseOptimizationStatus
    When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.
    apply_on lambda_.FunctionSnapStartResponseApplyOn
    When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.
    optimization_status lambda_.FunctionSnapStartResponseOptimizationStatus
    When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.
    applyOn "PublishedVersions" | "None"
    When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.
    optimizationStatus "On" | "Off"
    When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.

    FunctionSnapStartResponseApplyOn

    FunctionSnapStartResponseOptimizationStatus

    FunctionTracingConfig

    FunctionTracingConfigMode

    FunctionVpcConfig

    Ipv6AllowedForDualStack bool
    Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.
    SecurityGroupIds List<string>
    A list of VPC security group IDs.
    SubnetIds List<string>
    A list of VPC subnet IDs.
    Ipv6AllowedForDualStack bool
    Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.
    SecurityGroupIds []string
    A list of VPC security group IDs.
    SubnetIds []string
    A list of VPC subnet IDs.
    ipv6AllowedForDualStack Boolean
    Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.
    securityGroupIds List<String>
    A list of VPC security group IDs.
    subnetIds List<String>
    A list of VPC subnet IDs.
    ipv6AllowedForDualStack boolean
    Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.
    securityGroupIds string[]
    A list of VPC security group IDs.
    subnetIds string[]
    A list of VPC subnet IDs.
    ipv6_allowed_for_dual_stack bool
    Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.
    security_group_ids Sequence[str]
    A list of VPC security group IDs.
    subnet_ids Sequence[str]
    A list of VPC subnet IDs.
    ipv6AllowedForDualStack Boolean
    Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.
    securityGroupIds List<String>
    A list of VPC security group IDs.
    subnetIds List<String>
    A list of VPC subnet IDs.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi