Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-lambda-function.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::Lambda::Function. Source:- No source definition found, add manually please

Properties

Code object required
5 nested properties
S3ObjectVersion string | Aws_CF_FunctionString

For versioned objects, the version of the deployment package object to use.

S3Bucket string | Aws_CF_FunctionString

An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.

ZipFile string | Aws_CF_FunctionString

The source code of your Lambda function. If you include your function source inline with this parameter, AWS CloudFormation places it in a file named index and zips it to create a deployment package..

S3Key string | Aws_CF_FunctionString

The Amazon S3 key of the deployment package.

ImageUri string | Aws_CF_FunctionString

ImageUri.

Role string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the function's execution role.

Description string | Aws_CF_FunctionString

A description of the function.

TracingConfig object

The function's AWS X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active.

1 nested properties
Mode string | Aws_CF_FunctionString

The tracing mode.

VpcConfig object

The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC.

2 nested properties
SecurityGroupIds string[]

A list of VPC security groups IDs.

maxItems=5
SubnetIds string[]

A list of VPC subnet IDs.

maxItems=16
RuntimeManagementConfig object
2 nested properties
UpdateRuntimeOn string | Aws_CF_FunctionString required

Trigger for runtime update

RuntimeVersionArn string | Aws_CF_FunctionString

Unique identifier for a runtime version arn

ReservedConcurrentExecutions integer

The number of simultaneous executions to reserve for the function.

min=0
SnapStart object

The function's SnapStart setting. When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.

1 nested properties
ApplyOn string | Aws_CF_FunctionString required

Applying SnapStart setting on function resource type.

FileSystemConfigs FileSystemConfig[]

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.

maxItems=1
FunctionName string | Aws_CF_FunctionString

The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one.

Runtime string | Aws_CF_FunctionString

The identifier of the function's runtime.

KmsKeyArn string | Aws_CF_FunctionString

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.

PackageType string | Aws_CF_FunctionString

PackageType.

CodeSigningConfigArn string | Aws_CF_FunctionString

A unique Arn for CodeSigningConfig resource

Layers string[]

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

Tags Tag[]

A list of tags to apply to the function.

uniqueItems=true
ImageConfig object
3 nested properties
WorkingDirectory string | Aws_CF_FunctionString

WorkingDirectory.

Command string[]

Command.

maxItems=1500uniqueItems=true
EntryPoint string[]

EntryPoint.

maxItems=1500uniqueItems=true
MemorySize integer

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

DeadLetterConfig object

The dead-letter queue for failed asynchronous invocations.

1 nested properties
TargetArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

Timeout integer

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.

min=1
Handler string | Aws_CF_FunctionString

The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime

Environment object

A function's environment variable settings.

1 nested properties
Variables object

Environment variable key-value pairs.

EphemeralStorage object

A function's ephemeral storage settings.

1 nested properties
Size integer required

The amount of ephemeral storage that your function has access to.

min=512max=10240
Architectures string[]
minItems=1maxItems=1uniqueItems=true

Definitions

ImageConfig object
WorkingDirectory string | Aws_CF_FunctionString

WorkingDirectory.

Command string[]

Command.

maxItems=1500uniqueItems=true
EntryPoint string[]

EntryPoint.

maxItems=1500uniqueItems=true
TracingConfig object

The function's AWS X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active.

Mode string | Aws_CF_FunctionString

The tracing mode.

VpcConfig object

The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC.

SecurityGroupIds string[]

A list of VPC security groups IDs.

maxItems=5
SubnetIds string[]

A list of VPC subnet IDs.

maxItems=16
DeadLetterConfig object

The dead-letter queue for failed asynchronous invocations.

TargetArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

RuntimeManagementConfig object
UpdateRuntimeOn string | Aws_CF_FunctionString required

Trigger for runtime update

RuntimeVersionArn string | Aws_CF_FunctionString

Unique identifier for a runtime version arn

SnapStart object

The function's SnapStart setting. When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.

ApplyOn string | Aws_CF_FunctionString required

Applying SnapStart setting on function resource type.

SnapStartResponse object

The function's SnapStart Response. When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.

OptimizationStatus string | Aws_CF_FunctionString

Indicates whether SnapStart is activated for the specified function version.

ApplyOn string | Aws_CF_FunctionString

Applying SnapStart setting on function resource type.

Code object
S3ObjectVersion string | Aws_CF_FunctionString

For versioned objects, the version of the deployment package object to use.

S3Bucket string | Aws_CF_FunctionString

An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.

ZipFile string | Aws_CF_FunctionString

The source code of your Lambda function. If you include your function source inline with this parameter, AWS CloudFormation places it in a file named index and zips it to create a deployment package..

S3Key string | Aws_CF_FunctionString

The Amazon S3 key of the deployment package.

ImageUri string | Aws_CF_FunctionString

ImageUri.

Environment object

A function's environment variable settings.

Variables object

Environment variable key-value pairs.

FileSystemConfig object
Arn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

LocalMountPath string | Aws_CF_FunctionString required

The path where the function can access the file system, starting with /mnt/.

Tag object
Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

EphemeralStorage object

A function's ephemeral storage settings.

Size integer required

The amount of ephemeral storage that your function has access to.

min=512max=10240