BundlingOptions

class aws_cdk.aws_lambda_python_alpha.BundlingOptions(*, command=None, entrypoint=None, environment=None, network=None, platform=None, security_opt=None, user=None, volumes=None, volumes_from=None, working_directory=None, asset_excludes=None, asset_hash=None, asset_hash_type=None, build_args=None, bundling_file_access=None, command_hooks=None, image=None, output_path_suffix=None, poetry_include_hashes=None, poetry_without_urls=None)

Bases: DockerRunOptions

(experimental) Options for bundling.

Parameters:

  • command (Optional[Sequence[str]]) – The command to run in the container. Default: - run the command defined in the image

  • entrypoint (Optional[Sequence[str]]) – The entrypoint to run in the container. Default: - run the entrypoint defined in the image

  • environment (Optional[Mapping[str, str]]) – The environment variables to pass to the container. Default: - no environment variables.

  • network (Optional[str]) – Docker Networking options. Default: - no networking options

  • platform (Optional[str]) – Set platform if server is multi-platform capable. Requires Docker Engine API v1.38+. Example value: linux/amd64 Default: - no platform specified

  • security_opt (Optional[str]) – Security configuration when running the docker container. Default: - no security options

  • user (Optional[str]) – The user to use when running the container. Default: - root or image default

  • volumes (Optional[Sequence[Union[DockerVolume, Dict[str, Any]]]]) – Docker volumes to mount. Default: - no volumes are mounted

  • volumes_from (Optional[Sequence[str]]) – Where to mount the specified volumes from. Default: - no containers are specified to mount volumes from

  • working_directory (Optional[str]) – Working directory inside the container. Default: - image default

  • asset_excludes (Optional[Sequence[str]]) – (experimental) List of file patterns to exclude when copying assets from source for bundling. Default: - Empty list

  • asset_hash (Optional[str]) – (experimental) Specify a custom hash for this asset. If assetHashType is set it must be set to AssetHashType.CUSTOM. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - Based on assetHashType

  • asset_hash_type (Optional[AssetHashType]) – (experimental) Determines how asset hash is calculated. Assets will get rebuild and uploaded only if their hash has changed. If asset hash is set to SOURCE (default), then only changes to the source directory will cause the asset to rebuild. This means, for example, that in order to pick up a new dependency version, a change must be made to the source tree. Ideally, this can be implemented by including a dependency lockfile in your source tree or using fixed dependencies. If the asset hash is set to OUTPUT, the hash is calculated after bundling. This means that any change in the output will cause the asset to be invalidated and uploaded. Bear in mind that pip adds timestamps to dependencies it installs, which implies that in this mode Python bundles will always get rebuild and uploaded. Normally this is an anti-pattern since build Default: AssetHashType.SOURCE By default, hash is calculated based on the contents of the source directory. This means that only updates to the source will cause the asset to rebuild.

  • build_args (Optional[Mapping[str, str]]) – (experimental) Optional build arguments to pass to the default container. This can be used to customize the index URLs used for installing dependencies. This is not used if a custom image is provided. Default: - No build arguments.

  • bundling_file_access (Optional[BundlingFileAccess]) – (experimental) Which option to use to copy the source files to the docker container and output files back. Default: - BundlingFileAccess.BIND_MOUNT

  • command_hooks (Optional[ICommandHooks]) – (experimental) Command hooks. Default: - do not run additional commands

  • image (Optional[DockerImage]) – (experimental) Docker image to use for bundling. If no options are provided, the default bundling image will be used. Dependencies will be installed using the default packaging commands and copied over from into the Lambda asset. Default: - Default bundling image.

  • output_path_suffix (Optional[str]) – (experimental) Output path suffix: the suffix for the directory into which the bundled output is written. Default: - ‘python’ for a layer, empty string otherwise.

  • poetry_include_hashes (Optional[bool]) – (experimental) Whether to export Poetry dependencies with hashes. Note that this can cause builds to fail if not all dependencies export with a hash. Default: Hashes are NOT included in the exported requirements.txt file

  • poetry_without_urls (Optional[bool]) – (experimental) Whether to export Poetry dependencies with source repository urls. Default: URLs are included in the exported requirements.txt file.

Stability:

experimental

ExampleMetadata:

infused

Example:

entry = "/path/to/function"
image = DockerImage.from_build(entry)

python.PythonFunction(self, "function",
    entry=entry,
    runtime=Runtime.PYTHON_3_8,
    bundling=python.BundlingOptions(
        build_args={"PIP_INDEX_URL": "https://your.index.url/simple/", "PIP_EXTRA_INDEX_URL": "https://your.extra-index.url/simple/"}
    )
)

Attributes

asset_excludes

(experimental) List of file patterns to exclude when copying assets from source for bundling.

Default:

  • Empty list

Stability:

experimental

asset_hash

(experimental) Specify a custom hash for this asset.

If assetHashType is set it must be set to AssetHashType.CUSTOM. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.

NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated.

Default:

  • Based on assetHashType

Stability:

experimental

asset_hash_type

(experimental) Determines how asset hash is calculated. Assets will get rebuild and uploaded only if their hash has changed.

If asset hash is set to SOURCE (default), then only changes to the source directory will cause the asset to rebuild. This means, for example, that in order to pick up a new dependency version, a change must be made to the source tree. Ideally, this can be implemented by including a dependency lockfile in your source tree or using fixed dependencies.

If the asset hash is set to OUTPUT, the hash is calculated after bundling. This means that any change in the output will cause the asset to be invalidated and uploaded. Bear in mind that pip adds timestamps to dependencies it installs, which implies that in this mode Python bundles will always get rebuild and uploaded. Normally this is an anti-pattern since build

Default:

AssetHashType.SOURCE By default, hash is calculated based on the contents of the source directory. This means that only updates to the source will cause the asset to rebuild.

Stability:

experimental

build_args

(experimental) Optional build arguments to pass to the default container.

This can be used to customize the index URLs used for installing dependencies. This is not used if a custom image is provided.

Default:

  • No build arguments.

Stability:

experimental

bundling_file_access

(experimental) Which option to use to copy the source files to the docker container and output files back.

Default:

  • BundlingFileAccess.BIND_MOUNT

Stability:

experimental

command

The command to run in the container.

Default:

  • run the command defined in the image

command_hooks

(experimental) Command hooks.

Default:

  • do not run additional commands

Stability:

experimental

entrypoint

The entrypoint to run in the container.

Default:

  • run the entrypoint defined in the image

environment

The environment variables to pass to the container.

Default:

  • no environment variables.

image

(experimental) Docker image to use for bundling.

If no options are provided, the default bundling image will be used. Dependencies will be installed using the default packaging commands and copied over from into the Lambda asset.

Default:

  • Default bundling image.

Stability:

experimental

network

//docs.docker.com/engine/reference/commandline/run/#connect-a-container-to-a-network—network>`_.

Default:

  • no networking options

Type:

Docker `Networking options <https

output_path_suffix

the suffix for the directory into which the bundled output is written.

Default:

  • ‘python’ for a layer, empty string otherwise.

Stability:

experimental

Type:

(experimental) Output path suffix

platform

Set platform if server is multi-platform capable. Requires Docker Engine API v1.38+.

Example value: linux/amd64

Default:

  • no platform specified

poetry_include_hashes

(experimental) Whether to export Poetry dependencies with hashes.

Note that this can cause builds to fail if not all dependencies export with a hash.

Default:

Hashes are NOT included in the exported requirements.txt file

See:

https://github.com/aws/aws-cdk/issues/19232

Stability:

experimental

poetry_without_urls

(experimental) Whether to export Poetry dependencies with source repository urls.

Default:

URLs are included in the exported requirements.txt file.

Stability:

experimental

security_opt

//docs.docker.com/engine/reference/run/#security-configuration>`_ when running the docker container.

Default:

  • no security options

Type:

`Security configuration <https

user

The user to use when running the container.

Default:

  • root or image default

volumes

Docker volumes to mount.

Default:

  • no volumes are mounted

volumes_from

Where to mount the specified volumes from.

Default:

  • no containers are specified to mount volumes from

See:

https://docs.docker.com/engine/reference/commandline/run/#mount-volumes-from-container—volumes-from

working_directory

Working directory inside the container.

Default:

  • image default