interface ILayerVersion
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Lambda.ILayerVersion |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awslambda#ILayerVersion |
![]() | software.amazon.awscdk.services.lambda.ILayerVersion |
![]() | aws_cdk.aws_lambda.ILayerVersion |
![]() | aws-cdk-lib » aws_lambda » ILayerVersion |
Implemented by
Layer
, Aws
, Node
, Python
Obtainable from
Layer
.fromLayerVersionArn()
, Layer
.fromLayerVersionAttributes()
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
layer | string | The ARN of the Lambda Layer version that this Layer defines. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
compatible | Runtime [] | The runtimes compatible with this Layer. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
layerVersionArn
Type:
string
The ARN of the Lambda Layer version that this Layer defines.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
compatibleRuntimes?
Type:
Runtime
[]
(optional, default: Runtime.All)
The runtimes compatible with this Layer.
Methods
Name | Description |
---|---|
add | Add permission for this layer version to specific entities. |
apply | Apply the given removal policy to this resource. |
addPermission(id, permission)
public addPermission(id: string, permission: LayerVersionPermission): void
Parameters
- id
string
— the ID of the grant in the construct tree. - permission
Layer
— the identification of the grantee.Version Permission
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
Removal
Policy
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
).