BundlingOptions

class aws_cdk.BundlingOptions(*, image, command=None, entrypoint=None, environment=None, local=None, network=None, output_type=None, security_opt=None, user=None, volumes=None, volumes_from=None, working_directory=None)

Bases: object

Bundling options.

Parameters

image (DockerImage) – The Docker image where the command will run.
command (Optional[Sequence[str]]) – The command to run in the Docker container. Example value: ['npm', 'install'] Default: - run the command defined in the image
entrypoint (Optional[Sequence[str]]) – The entrypoint to run in the Docker container. Example value: ['/bin/sh', '-c'] Default: - run the entrypoint defined in the image
environment (Optional[Mapping[str, str]]) – The environment variables to pass to the Docker container. Default: - no environment variables.
local (Optional[ILocalBundling]) – Local bundling provider. The provider implements a method tryBundle() which should return true if local bundling was performed. If false is returned, docker bundling will be done. Default: - bundling will only be performed in a Docker container
network (Optional[str]) – Docker Networking options. Default: - no networking options
output_type (Optional[BundlingOutput]) – The type of output that this bundling operation is producing. Default: BundlingOutput.AUTO_DISCOVER
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 Docker container. user | user:group | uid | uid:gid | user:gid | uid:group Default: - uid:gid of the current user or 1000:1000 on Windows
volumes (Optional[Sequence[Union[DockerVolume, Dict[str, Any]]]]) – Additional Docker volumes to mount. Default: - no additional 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 Docker container. Default: /asset-input

ExampleMetadata

infused

Example:

# Example automatically generated from non-compiling source. May contain errors.
asset = assets.Asset(self, "BundledAsset",
    path="/path/to/asset",
    bundling=BundlingOptions(
        image=ambda.Runtime.PYTHON_3_9.bundling_image,
        command=["bash", "-c", "pip install -r requirements.txt -t /asset-output && cp -au . /asset-output"
        ],
        security_opt="no-new-privileges:true",  # https://docs.docker.com/engine/reference/commandline/run/#optional-security-options---security-opt
        network="host"
    )
)

Attributes

command

The command to run in the Docker container.

Example value: ['npm', 'install']

Default

run the command defined in the image

See

https://docs.docker.com/engine/reference/run/

entrypoint

The entrypoint to run in the Docker container.

Example value: ['/bin/sh', '-c']

Default

run the entrypoint defined in the image

See

https://docs.docker.com/engine/reference/builder/#entrypoint

environment

The environment variables to pass to the Docker container.

Default

no environment variables.

image: The Docker image where the command will run.

local

Local bundling provider.

The provider implements a method tryBundle() which should return true if local bundling was performed. If false is returned, docker bundling will be done.

Default

bundling will only be performed in a Docker container

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_type

The type of output that this bundling operation is producing.

Default: BundlingOutput.AUTO_DISCOVER

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 Docker container.

Default

uid:gid of the current user or 1000:1000 on Windows

See

https://docs.docker.com/engine/reference/run/#user

volumes

Additional Docker volumes to mount.

Default

no additional 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 Docker container.

Default: /asset-input