software.amazon.awscdk.core

Class BundlingDockerImage

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.BundlingDockerImage

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.15.0 (build 585166b)",
           date="2020-12-12T01:56:02.116Z")
 @Stability(value=Stable)
public class BundlingDockerImage
extends software.amazon.jsii.JsiiObject

A Docker image used for asset bundling.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BundlingDockerImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BundlingDockerImage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	cp(String imagePath, String outputPath) Copies a file or directory out of the Docker image to the local filesystem.
static BundlingDockerImage	fromAsset(String path) Reference an image that's built directly from sources on disk.
static BundlingDockerImage	fromAsset(String path, DockerBuildOptions options) Reference an image that's built directly from sources on disk.
static BundlingDockerImage	fromRegistry(String image) Reference an image on DockerHub or another online registry.
String	getImage() The Docker image.
void	run() Runs a Docker image.
void	run(DockerRunOptions options) Runs a Docker image.
String	toJSON() Provides a stable representation of this image for JSON serialization.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

BundlingDockerImage

protected BundlingDockerImage(software.amazon.jsii.JsiiObjectRef objRef)

BundlingDockerImage

protected BundlingDockerImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

fromAsset

@Stability(value=Stable)
 @NotNull
public static BundlingDockerImage fromAsset(@NotNull
                                                                               String path,
                                                                               @Nullable
                                                                               DockerBuildOptions options)

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

Parameters:

path - The path to the directory containing the Docker file. This parameter is required.

options - Docker build options.

fromAsset

@Stability(value=Stable)
 @NotNull
public static BundlingDockerImage fromAsset(@NotNull
                                                                               String path)

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

Parameters:

path - The path to the directory containing the Docker file. This parameter is required.

fromRegistry

@Stability(value=Stable)
 @NotNull
public static BundlingDockerImage fromRegistry(@NotNull
                                                                                  String image)

Reference an image on DockerHub or another online registry.

Parameters:

image - the image name. This parameter is required.

cp

@Stability(value=Stable)
public void cp(@NotNull
                                        String imagePath,
                                        @NotNull
                                        String outputPath)

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

Parameters:

imagePath - This parameter is required.

outputPath - This parameter is required.

run

@Stability(value=Stable)
public void run(@Nullable
                                         DockerRunOptions options)

Runs a Docker image.

Parameters:

options -

run

@Stability(value=Stable)
public void run()

Runs a Docker image.

toJSON

@Stability(value=Stable)
 @NotNull
public String toJSON()

Provides a stable representation of this image for JSON serialization.

Returns:

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

getImage

@Stability(value=Stable)
 @NotNull
public String getImage()

The Docker image.