software.amazon.awscdk.services.lambda

Class LayerVersion

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.lambda.LayerVersion

All Implemented Interfaces:

IConstruct, IDependable, IResource, ILayerVersion

Direct Known Subclasses:

AwsCliLayer, KubectlLayer, NodeProxyAgentLayer, PythonLayerVersion

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:54.589Z")
public class LayerVersion
extends Resource
implements ILayerVersion

Defines a new Lambda Layer version.

Example:

 LayerVersion.Builder.create(this, "MyLayer")
         .removalPolicy(RemovalPolicy.RETAIN)
         .code(Code.fromAsset(join(__dirname, "lambda-handler")))
         .compatibleArchitectures(List.of(Architecture.X86_64, Architecture.ARM_64))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LayerVersion.Builder A fluent builder for LayerVersion.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.ILayerVersion

ILayerVersion.Jsii$Default, ILayerVersion.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LayerVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LayerVersion(software.amazon.jsii.JsiiObjectRef objRef)
	LayerVersion(software.constructs.Construct scope, java.lang.String id, LayerVersionProps props)

Method Summary

Modifier and Type	Method and Description
void	addPermission(java.lang.String id, LayerVersionPermission permission) Add permission for this layer version to specific entities.
static ILayerVersion	fromLayerVersionArn(software.constructs.Construct scope, java.lang.String id, java.lang.String layerVersionArn) Imports a layer version by ARN.
static ILayerVersion	fromLayerVersionAttributes(software.constructs.Construct scope, java.lang.String id, LayerVersionAttributes attrs) Imports a Layer that has been defined externally.
java.util.List<Runtime>	getCompatibleRuntimes() The runtimes compatible with this Layer.
java.lang.String	getLayerVersionArn() The ARN of the Lambda Layer version that this Layer defines.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

LayerVersion

protected LayerVersion(software.amazon.jsii.JsiiObjectRef objRef)

LayerVersion

protected LayerVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

LayerVersion

public LayerVersion(software.constructs.Construct scope,
                    java.lang.String id,
                    LayerVersionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromLayerVersionArn

public static ILayerVersion fromLayerVersionArn(software.constructs.Construct scope,
                                                java.lang.String id,
                                                java.lang.String layerVersionArn)

Imports a layer version by ARN.

Assumes it is compatible with all Lambda runtimes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

layerVersionArn - This parameter is required.

fromLayerVersionAttributes

public static ILayerVersion fromLayerVersionAttributes(software.constructs.Construct scope,
                                                       java.lang.String id,
                                                       LayerVersionAttributes attrs)

Imports a Layer that has been defined externally.

Parameters:

scope - the parent Construct that will use the imported layer. This parameter is required.

id - the id of the imported layer in the construct tree. This parameter is required.

attrs - the properties of the imported layer. This parameter is required.

addPermission

public void addPermission(java.lang.String id,
                          LayerVersionPermission 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.

Specified by:

addPermission in interface ILayerVersion

Parameters:

id - This parameter is required.

permission - This parameter is required.

getLayerVersionArn

public java.lang.String getLayerVersionArn()

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

Specified by:

getLayerVersionArn in interface ILayerVersion

getCompatibleRuntimes

public java.util.List<Runtime> getCompatibleRuntimes()

The runtimes compatible with this Layer.

Specified by:

getCompatibleRuntimes in interface ILayerVersion