interface ILayerVersion

Language	Type name
.NET	Amazon.CDK.AWS.Lambda.ILayerVersion
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslambda#ILayerVersion
Java	software.amazon.awscdk.services.lambda.ILayerVersion
Python	aws_cdk.aws_lambda.ILayerVersion
TypeScript (source)	aws-cdk-lib » aws_lambda » ILayerVersion

Implements IDependable, IConstruct, IEnvironmentAware, IResource, ILayerVersionRef

Implemented by LayerVersion, AwsCliLayer, NodeProxyAgentLayer, PythonLayerVersion

Obtainable from LayerVersion.fromLayerVersionArn(), LayerVersion.fromLayerVersionAttributes()

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
layerVersionArn	string	The ARN of the Lambda Layer version that this Layer defines.
layerVersionRef🔹	LayerVersionReference	A reference to a LayerVersion resource.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
compatibleRuntimes?	Runtime[]	The runtimes compatible with this Layer.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

layerVersionArn

Type: string

The ARN of the Lambda Layer version that this Layer defines.

---

layerVersionRef🔹

Type: LayerVersionReference

A reference to a LayerVersion resource.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

compatibleRuntimes?

Type: Runtime[] (optional, default: All supported runtimes. Setting this to Runtime.ALL is equivalent to leaving it undefined.)

The runtimes compatible with this Layer.

Methods

Name	Description
addPermission(id, permission)	Add permission for this layer version to specific entities.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
with(...mixins)	Applies one or more mixins to this construct.

---

addPermission(id, permission)

public addPermission(id: string, permission: LayerVersionPermission): void

Parameters

• id string — the ID of the grant in the construct tree.
• permission LayerVersionPermission — the identification of the grantee.

Add permission for this layer version to specific entities.

Usage within the same account where the layer is defined is always allowed and does not require calling this method. Note that the principal that creates the Lambda function using the layer (for example, a CloudFormation changeset execution role) also needs to have the lambda:GetLayerVersion permission on the layer version.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.