PythonLayerVersion

class aws_cdk.aws_lambda_python.PythonLayerVersion(scope, id, *, entry, compatible_architectures=None, compatible_runtimes=None, description=None, layer_version_name=None, license=None, removal_policy=None)

Bases: aws_cdk.aws_lambda.LayerVersion

(experimental) A lambda layer version.

Stability

experimental

Example:

lambda_.PythonFunction(self, "MyFunction",
    entry="/path/to/my/function",
    layers=[
        lambda_.PythonLayerVersion(self, "MyLayer",
            entry="/path/to/my/layer"
        )
    ]
)
Parameters

  • scope (Construct) –

  • id (str) –

  • entry (str) – (experimental) The path to the root directory of the lambda layer.

  • compatible_architectures (Optional[Sequence[Architecture]]) – (experimental) The system architectures compatible with this layer. Default: [Architecture.X86_64]

  • compatible_runtimes (Optional[Sequence[Runtime]]) – (experimental) The runtimes compatible with the python layer. Default: - All runtimes are supported.

  • description (Optional[str]) – The description the this Lambda Layer. Default: - No description.

  • layer_version_name (Optional[str]) – The name of the layer. Default: - A name will be generated.

  • license (Optional[str]) – The SPDX licence identifier or URL to the license file for this layer. Default: - No license information will be recorded.

  • removal_policy (Optional[RemovalPolicy]) – Whether to retain this version of the layer when a new version is added or when the stack is deleted. Default: RemovalPolicy.DESTROY

Stability

experimental

Methods

add_permission(id, *, account_id, organization_id=None)

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.

Parameters

  • id (str) –

  • account_id (str) – The AWS Account id of the account that is authorized to use a Lambda Layer Version. The wild-card '*' can be used to grant access to “any” account (or any account in an organization when organizationId is specified).

  • organization_id (Optional[str]) – The ID of the AWS Organization to which the grant is restricted. Can only be specified if accountId is '*'

Return type

None

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

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

compatible_runtimes

The runtimes compatible with this Layer.

Return type

Optional[List[Runtime]]

env

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.

Return type

ResourceEnvironment

layer_version_arn

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

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_layer_version_arn(scope, id, layer_version_arn)

Imports a layer version by ARN.

Assumes it is compatible with all Lambda runtimes.

Parameters

  • scope (Construct) –

  • id (str) –

  • layer_version_arn (str) –

Return type

ILayerVersion

classmethod from_layer_version_attributes(scope, id, *, compatible_runtimes=None, layer_version_arn)

Imports a Layer that has been defined externally.

Parameters

  • scope (Construct) – the parent Construct that will use the imported layer.

  • id (str) – the id of the imported layer in the construct tree.

  • compatible_runtimes (Optional[Sequence[Runtime]]) – The list of compatible runtimes with this Layer.

  • layer_version_arn (str) – The ARN of the LayerVersion.

Return type

ILayerVersion

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool