AWS::Lambda::LayerVersion - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Lambda::LayerVersion

The AWS::Lambda::LayerVersion resource creates a Lambda layer from a ZIP archive.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Lambda::LayerVersion",
  "Properties" : {
      "CompatibleArchitectures" : [ String, ... ],
      "CompatibleRuntimes" : [ String, ... ],
      "Content" : Content,
      "Description" : String,
      "LayerName" : String,
      "LicenseInfo" : String
    }
}

YAML

Type: AWS::Lambda::LayerVersion
Properties:
  CompatibleArchitectures: 
    - String
  CompatibleRuntimes: 
    - String
  Content: 
    Content
  Description: String
  LayerName: String
  LicenseInfo: String

Properties

CompatibleArchitectures

A list of compatible instruction set architectures.

Required: No

Type: Array of String

Minimum: 0

Maximum: 2

Update requires: Replacement

CompatibleRuntimes

A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.

Required: No

Type: Array of String

Minimum: 0

Maximum: 15

Update requires: Replacement

Content

The function layer archive.

Required: Yes

Type: Content

Update requires: Replacement

Description

The description of the version.

Required: No

Type: String

Minimum: 0

Maximum: 256

Update requires: Replacement

LayerName

The name or Amazon Resource Name (ARN) of the layer.

Required: No

Type: String

Pattern: (arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+

Minimum: 1

Maximum: 140

Update requires: Replacement

LicenseInfo

The layer's software license. It can be any of the following:

  • An SPDX license identifier. For example, MIT.

  • The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT.

  • The full text of the license.

Required: No

Type: String

Minimum: 0

Maximum: 512

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the layer version, such as arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1.

For more information about using the Ref function, see Ref.

Fn::GetAtt

LayerVersionArn

The ARN of the layer version.

Examples

Layer Version

Create a layer named my-layer.

JSON

"MyLayer": {
    "Type": "AWS::Lambda::LayerVersion",
    "Properties": {
        "CompatibleRuntimes": [
            "python3.12",
            "python3.11"
        ],
        "Content": {
            "S3Bucket": "amzn-s3-demo-bucket",
            "S3Key": "layer.zip"
        },
        "Description": "My layer",
        "LayerName": "my-layer",
        "LicenseInfo": "MIT"
    }
}

YAML

MyLayer:
  Type: AWS::Lambda::LayerVersion
  Properties:
    CompatibleRuntimes:
      - python3.12
      - python3.11
    Content:
      S3Bucket: amzn-s3-demo-bucket
      S3Key: layer.zip
    Description: My layer
    LayerName: my-layer
    LicenseInfo: MIT