LayerVersionOptions

class aws_cdk.aws_lambda.LayerVersionOptions(*, description=None, layer_version_name=None, license=None, removal_policy=None)

Bases: object

Non runtime options.

Parameters:

  • 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_lambda as lambda_

layer_version_options = lambda.LayerVersionOptions(
    description="description",
    layer_version_name="layerVersionName",
    license="license",
    removal_policy=cdk.RemovalPolicy.DESTROY
)

Attributes

description

The description the this Lambda Layer.

Default:

  • No description.

layer_version_name

The name of the layer.

Default:

  • A name will be generated.

license

The SPDX licence identifier or URL to the license file for this layer.

Default:

  • No license information will be recorded.

removal_policy

Whether to retain this version of the layer when a new version is added or when the stack is deleted.

Default:

RemovalPolicy.DESTROY