class AwsCliLayer

Language	Type name
.NET	Amazon.CDK.LambdaLayer.AwsCli.AwsCliLayer
Go	github.com/aws/aws-cdk-go/awscdk/v2/lambdalayerawscli#AwsCliLayer
Java	software.amazon.awscdk.lambdalayer.awscli.AwsCliLayer
Python	aws_cdk.lambda_layer_awscli.AwsCliLayer
TypeScript (source)	aws-cdk-lib » lambda_layer_awscli » AwsCliLayer

Implements IConstruct, IDependable, IResource, ILayerVersion

Extends LayerVersion

An AWS Lambda layer that includes the AWS CLI.

Example

// AwsCliLayer bundles the AWS CLI in a lambda layer
import { AwsCliLayer } from 'aws-cdk-lib/lambda-layer-awscli';

declare const fn: lambda.Function;
fn.addLayers(new AwsCliLayer(this, 'AwsCliLayer'));

Initializer

new AwsCliLayer(scope: Construct, id: string)

Parameters

• scope Construct
• id string

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.
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 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)

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.
toString()	Returns a string representation of this construct.

---

addPermission(id, permission)

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

Parameters

• id string
• permission LayerVersionPermission

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).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.