Class BundlingDockerImage
(deprecated) A Docker image used for asset bundling.
Namespace: Amazon.CDK
Assembly: Amazon.CDK.dll
Syntax (csharp)
public class BundlingDockerImage : DeputyBase
Syntax (vb)
Public Class BundlingDockerImage
Inherits DeputyBase
Remarks
Stability: Deprecated
ExampleMetadata: fixture=_generated
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"
});
Synopsis
Constructors
BundlingDockerImage(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
BundlingDockerImage(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
BundlingDockerImage(String, String) |
Properties
Image | (deprecated) The Docker image. |
Methods
Cp(String, String) | (deprecated) Copies a file or directory out of the Docker image to the local filesystem. |
FromAsset(String, IDockerBuildOptions) | (deprecated) Reference an image that's built directly from sources on disk. |
FromRegistry(String) | (deprecated) Reference an image on DockerHub or another online registry. |
Run(IDockerRunOptions) | (deprecated) Runs a Docker image. |
ToJSON() | (deprecated) Provides a stable representation of this image for JSON serialization. |
Constructors
BundlingDockerImage(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected BundlingDockerImage(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
BundlingDockerImage(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected BundlingDockerImage(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
BundlingDockerImage(String, String)
public BundlingDockerImage(string image, string imageHash = null)
Parameters
- image System.String
The Docker image.
- imageHash System.String
The Docker image.
Remarks
Stability: Deprecated
Properties
Image
(deprecated) The Docker image.
public virtual string Image { get; }
Property Value
System.String
Remarks
Stability: Deprecated
Methods
Cp(String, String)
(deprecated) Copies a file or directory out of the Docker image to the local filesystem.
public virtual string Cp(string imagePath, string outputPath = null)
Parameters
- imagePath System.String
the path in the Docker image.
- outputPath System.String
the destination path for the copy operation.
Returns
System.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.
public static BundlingDockerImage FromAsset(string path, IDockerBuildOptions options = null)
Parameters
- path System.String
The path to the directory containing the Docker file.
- options IDockerBuildOptions
Docker build options.
Returns
Remarks
Stability: Deprecated
FromRegistry(String)
(deprecated) Reference an image on DockerHub or another online registry.
public static DockerImage FromRegistry(string image)
Parameters
- image System.String
the image name.
Returns
Remarks
Stability: Deprecated
Run(IDockerRunOptions)
(deprecated) Runs a Docker image.
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.
public virtual string ToJSON()
Returns
System.String
The overridden image name if set or image hash name in that order
Remarks
Stability: Deprecated