Table of Contents

Class BundlingDockerImage

Namespace
Amazon.CDK
Assembly
Amazon.CDK.dll

(deprecated) A Docker image used for asset bundling.

[Obsolete("use DockerImage")]
public class BundlingDockerImage : DeputyBase
Inheritance
BundlingDockerImage
Derived

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             var bundlingDockerImage = BundlingDockerImage.FromAsset("path", new DockerBuildOptions {
                 BuildArgs = new Dictionary<string, string> {
                     { "buildArgsKey", "buildArgs" }
                 },
                 File = "file",
                 Platform = "platform"
             });

Remarks

Stability: Deprecated

ExampleMetadata: fixture=_generated

Constructors

BundlingDockerImage(string, string?)

[Obsolete]
public BundlingDockerImage(string image, string? imageHash = null)

Parameters

image string

The Docker image.

imageHash string

Remarks

Stability: Deprecated

Properties

Image

(deprecated) The Docker image.

[Obsolete]
public virtual string Image { get; }

Property Value

string

Remarks

Stability: Deprecated

Methods

Cp(string, string?)

(deprecated) Copies a file or directory out of the Docker image to the local filesystem.

[Obsolete]
public virtual string Cp(string imagePath, string? outputPath = null)

Parameters

imagePath string

the path in the Docker image.

outputPath string

the destination path for the copy operation.

Returns

string

the destination path

Remarks

If outputPath is omitted the destination path is a temporary directory.

Stability: Deprecated

FromAsset(string, IDockerBuildOptions?)

(deprecated) Reference an image that's built directly from sources on disk.

[Obsolete("use DockerImage.fromBuild()")]
public static BundlingDockerImage FromAsset(string path, IDockerBuildOptions? options = null)

Parameters

path string

The path to the directory containing the Docker file.

options IDockerBuildOptions

Docker build options.

Returns

BundlingDockerImage

Remarks

Stability: Deprecated

FromRegistry(string)

(deprecated) Reference an image on DockerHub or another online registry.

[Obsolete]
public static DockerImage FromRegistry(string image)

Parameters

image string

the image name.

Returns

DockerImage

Remarks

Stability: Deprecated

Run(IDockerRunOptions?)

(deprecated) Runs a Docker image.

[Obsolete]
public virtual void Run(IDockerRunOptions? options = null)

Parameters

options IDockerRunOptions

Remarks

Stability: Deprecated

ToJSON()

(deprecated) Provides a stable representation of this image for JSON serialization.

[Obsolete]
public virtual string ToJSON()

Returns

string

The overridden image name if set or image hash name in that order

Remarks

Stability: Deprecated