aws-cdk-lib.BundlingOptions

BundlingOptions Struct

Bundling options.

Source

core/lib/bundling.ts

Type last changed

v2.88.0 · 20 Jul 2023

Example

import * as cdk from 'aws-cdk-lib';

const asset = new Asset(this, 'BundledAsset', {
  path: '/path/to/asset',
  bundling: {
    image: cdk.DockerImage.fromRegistry('alpine'),
    command: ['command-that-produces-an-archive.sh'],
    outputType: cdk.BundlingOutput.NOT_ARCHIVED, // Bundling output will be zipped even though it produces a single archive file.
  },
});

Properties

bundlingFileAccess?optionalBundlingFileAccessbundling_file_access?optionalBundlingFileAccessbundlingFileAccess?optionalBundlingFileAccessBundlingFileAccess?optionalBundlingFileAccessBundlingFileAccess?optionalBundlingFileAccess= BundlingFileAccess.BIND_MOUNT#

The access mechanism used to make source files available to the bundling container and to return the bundling output back to the host.

command?optionalstring[]command?optionaltyping.List[str]command?optionalList<String>Command?optionalstring[]Command?optional*[]*string#

The command to run in the Docker container.

Default: run the command defined in the image

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

entrypoint?optionalstring[]entrypoint?optionaltyping.List[str]entrypoint?optionalList<String>Entrypoint?optionalstring[]Entrypoint?optional*[]*string#

The entrypoint to run in the Docker container.

Default: run the entrypoint defined in the image

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

environment?optional{ [key: string]: string }environment?optionaltyping.Mapping[str, str]environment?optionalMap<String, String>Environment?optionalIDictionary<string, string>Environment?optional*map[string]*string#

The environment variables to pass to the Docker container.

Default: no environment variables.

imageDockerImageimageDockerImageimageDockerImageImageDockerImageImageDockerImagerequired#

The Docker image where the command will run.

local?optionalILocalBundlinglocal?optionalILocalBundlinglocal?optionalILocalBundlingLocal?optionalILocalBundlingLocal?optionalILocalBundling#

Local bundling provider.

Default: bundling will only be performed in a Docker container

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

network?optionalstringnetwork?optionalstrnetwork?optionalStringNetwork?optionalstringNetwork?optional*string#

Docker [Networking options](https://docs.docker.com/engine/reference/commandline/run/#connect-a-container-to-a-network---network).

Default: no networking options

outputType?optionalBundlingOutputoutput_type?optionalBundlingOutputoutputType?optionalBundlingOutputOutputType?optionalBundlingOutputOutputType?optionalBundlingOutput= BundlingOutput.AUTO_DISCOVER#

The type of output that this bundling operation is producing.

platform?optionalstringplatform?optionalstrplatform?optionalStringPlatform?optionalstringPlatform?optional*string#

Platform to build for. _Requires Docker Buildx_.

Default: no platform specified (the current machine architecture will be used)

Specify this property to build images on a specific platform.

securityOpt?optionalstringsecurity_opt?optionalstrsecurityOpt?optionalStringSecurityOpt?optionalstringSecurityOpt?optional*string#

[Security configuration](https://docs.docker.com/engine/reference/run/#security-configuration) when running the docker container.

Default: no security options

user?optionalstringuser?optionalstruser?optionalStringUser?optionalstringUser?optional*string#

The user to use when running the Docker container.

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

user | user:group | uid | uid:gid | user:gid | uid:group

volumes?optionalDockerVolume[]volumes?optionaltyping.List[DockerVolume]volumes?optionalList<DockerVolume>Volumes?optionalDockerVolume[]Volumes?optional*[]DockerVolume#

Additional Docker volumes to mount.

Default: no additional volumes are mounted

volumesFrom?optionalstring[]volumes_from?optionaltyping.List[str]volumesFrom?optionalList<String>VolumesFrom?optionalstring[]VolumesFrom?optional*[]*string#

Where to mount the specified volumes from.

Default: no containers are specified to mount volumes from

workingDirectory?optionalstringworking_directory?optionalstrworkingDirectory?optionalStringWorkingDirectory?optionalstringWorkingDirectory?optional*string= /asset-input#

Working directory inside the Docker container.