Interface IBundlingOptions

Bundling options.

Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IBundlingOptions
Syntax (vb)
Public Interface IBundlingOptions
Remarks

ExampleMetadata: infused

Examples
using Amazon.CDK;


var asset = new Asset(this, "BundledAsset", new AssetProps {
    Path = "/path/to/asset",
    Bundling = new BundlingOptions {
        Image = DockerImage.FromRegistry("alpine"),
        Command = new [] { "command-that-produces-an-archive.sh" },
        OutputType = BundlingOutput.NOT_ARCHIVED
    }
});

Synopsis

Properties

BundlingFileAccess

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

The command to run in the Docker container.
Entrypoint

The entrypoint to run in the Docker container.
Environment

The environment variables to pass to the Docker container.
Image

The Docker image where the command will run.
Local

Local bundling provider.
Network

Docker Networking options.
OutputType

The type of output that this bundling operation is producing.
Platform

Platform to build for. Requires Docker Buildx.
SecurityOpt

Security configuration when running the docker container.
User

The user to use when running the Docker container.
Volumes

Additional Docker volumes to mount.
VolumesFrom

Where to mount the specified volumes from.
WorkingDirectory

Working directory inside the Docker container.

Properties

BundlingFileAccess

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

virtual Nullable<BundlingFileAccess> BundlingFileAccess { get; }
Property Value

System.Nullable<BundlingFileAccess>

Remarks

Default: - BundlingFileAccess.BIND_MOUNT

Command

The command to run in the Docker container.

virtual string[] Command { get; }
Property Value

System.String[]

Remarks

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.

virtual string[] Entrypoint { get; }
Property Value

System.String[]

Remarks

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.

virtual IDictionary<string, string> Environment { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Remarks

Default: - no environment variables.

Image

The Docker image where the command will run.

DockerImage Image { get; }
Property Value

DockerImage

Local

Local bundling provider.

virtual ILocalBundling Local { get; }
Property Value

ILocalBundling

Remarks

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

Docker Networking options.

virtual string Network { get; }
Property Value

System.String

Remarks

Default: - no networking options

OutputType

The type of output that this bundling operation is producing.

virtual Nullable<BundlingOutput> OutputType { get; }
Property Value

System.Nullable<BundlingOutput>

Remarks

Default: BundlingOutput.AUTO_DISCOVER

Platform

Platform to build for. Requires Docker Buildx.

virtual string Platform { get; }
Property Value

System.String

Remarks

Specify this property to build images on a specific platform.

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

SecurityOpt

Security configuration when running the docker container.

virtual string SecurityOpt { get; }
Property Value

System.String

Remarks

Default: - no security options

User

The user to use when running the Docker container.

virtual string User { get; }
Property Value

System.String

Remarks

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

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.

virtual IDockerVolume[] Volumes { get; }
Property Value

IDockerVolume[]

Remarks

Default: - no additional volumes are mounted

VolumesFrom

Where to mount the specified volumes from.

virtual string[] VolumesFrom { get; }
Property Value

System.String[]

Remarks

Default: - no containers are specified to mount volumes from

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

WorkingDirectory

Working directory inside the Docker container.

virtual string WorkingDirectory { get; }
Property Value

System.String

Remarks

Default: /asset-input