Cloud.Service.AWS.Lambda.Function

JSON Example

{
    "arn": "string",
    "dead_letter_config": [
        {
            "target_arn": "string"
        }
    ],
    "description": "string",
    "environment": [
        {}
    ],
    "filename": "string",
    "function_name": "string",
    "handler": "string",
    "invoke_arn": "string",
    "kms_key_arn": "string",
    "last_modified": "string",
    "memory_size": 0,
    "provider": "string",
    "provider_region": "string",
    "publish": false,
    "qualified_arn": "string",
    "reserved_concurrent_executions": 0,
    "role": "string",
    "runtime": "string",
    "s3_bucket": "string",
    "s3_key": "string",
    "s3_object_version": "string",
    "source_code_hash": "string",
    "source_code_size": 0,
    "timeout": 0,
    "tracing_config": [
        {
            "mode": "string"
        }
    ],
    "version": "string",
    "vpc_config": [
        {
            "security_group_ids": [
                "string"
            ],
            "subnet_ids": [
                "string"
            ],
            "vpc_id": "string"
        }
    ]
}

string

arn

Optional

The Amazon Resource Name (ARN) assigned by AWS to the Lambda function.

array of object

dead_letter_config

Optional

Settings for the nested block to configure the function dead letter queue.

string

description

Optional

Free-form text that explains what the function does.

array of object

environment

Optional

Settings that describe the function environment configuration.

string

filename

Optional

Path to the function deployment package in the local filesystem. Cannot be used with S3.

string

function_name

Required

(Required) Free-form, unique name of the function.

string

handler

Required

(Required) The function entry point in the code.

string

invoke_arn

Optional

ARN used for invoking the function using API Gateway Integration.

string

kms_key_arn

Optional

The ARN assigned by AWS to the function KMS encryption key.

string

last_modified

Optional

Date when the function was last modified.

integer

memory_size

Optional

Maximum memory, in megabytes, that the function can use at runtime. Default is 128.

string

provider

Required

(Required) The name of the AWS cloud account to use for this resource

string

provider_region

Required

(Required) Target cloud region, such as us-east-1. Must be within the provider cloud account.

boolean

publish

Optional

Whether to publish a new function version upon each creation or change. Default is false.

string

qualified_arn

Optional

ARN assigned by AWS to the function version.

integer

reserved_concurrent_executions

Optional

Maximum reservations for concurrent executions of the function. Default is 1.

string

role

Required

(Required) IAM role that determines who can invoke the function and what resources the function can access.

string

runtime

Required

(Required) Code runtime library/language.

string

s3_bucket

Optional

S3 bucket location containing the function deployment package, which must reside in the same AWS region where you are creating the Lambda function. Cannot be used with filename.

string

s3_key

Optional

S3 key to the object containing the function deployment package. Cannot be used with filename.

string

s3_object_version

Optional

S3 object version that contains the function deployment package. Cannot be used with filename.

string

source_code_hash

Optional

Base 64 encoded SHA 256 hash of the deployment package specified in filename or S3. Used to trigger updates. Usually set by ${base64sha256(file("file.zip"))} where file.zip is the local filename of the function source archive.

integer

source_code_size

Optional

Size, in bytes, of the function ZIP file.

object