software.amazon.awscdk.core

Class DockerImage

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.BundlingDockerImage

software.amazon.awscdk.core.DockerImage

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:34.979Z")
public class DockerImage
extends BundlingDockerImage

A Docker image.

Example:

 String entry = "/path/to/function";
 DockerImage image = DockerImage.fromBuild(entry);
 PythonFunction.Builder.create(this, "function")
         .entry(entry)
         .runtime(Runtime.PYTHON_3_8)
         .bundling(BundlingOptions.builder()
                 .buildArgs(Map.of("PIP_INDEX_URL", "https://your.index.url/simple/", "PIP_EXTRA_INDEX_URL", "https://your.extra-index.url/simple/"))
                 .build())
         .build();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DockerImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DockerImage(software.amazon.jsii.JsiiObjectRef objRef)
	DockerImage(java.lang.String image, java.lang.String _imageHash)

Method Summary

Modifier and Type	Method and Description
java.lang.String	cp(java.lang.String imagePath) Copies a file or directory out of the Docker image to the local filesystem.
java.lang.String	cp(java.lang.String imagePath, java.lang.String outputPath) Copies a file or directory out of the Docker image to the local filesystem.
static DockerImage	fromBuild(java.lang.String path) Builds a Docker image.
static DockerImage	fromBuild(java.lang.String path, DockerBuildOptions options) Builds a Docker image.
static DockerImage	fromRegistry(java.lang.String image) Reference an image on DockerHub or another online registry.
java.lang.String	getImage() The Docker image.
void	run() Runs a Docker image.
void	run(DockerRunOptions options) Runs a Docker image.
java.lang.String	toJSON() Provides a stable representation of this image for JSON serialization.

Methods inherited from class software.amazon.awscdk.core.BundlingDockerImage

fromAsset, fromAsset

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerImage

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

DockerImage

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

DockerImage

public DockerImage(java.lang.String image,
                   java.lang.String _imageHash)

Parameters:

image - This parameter is required.

_imageHash -

Method Detail

fromBuild

public static DockerImage fromBuild(java.lang.String path,
                                    DockerBuildOptions options)

Builds a Docker image.

Parameters:

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

options - Docker build options.

fromBuild

public static DockerImage fromBuild(java.lang.String path)

Builds a Docker image.

Parameters:

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

fromRegistry

public static DockerImage fromRegistry(java.lang.String image)

Reference an image on DockerHub or another online registry.

Parameters:

image - the image name. This parameter is required.

cp

public java.lang.String cp(java.lang.String imagePath,
                           java.lang.String outputPath)

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

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

Overrides:

cp in class BundlingDockerImage

Parameters:

imagePath - the path in the Docker image. This parameter is required.

outputPath - the destination path for the copy operation.

Returns:

the destination path

cp

public java.lang.String cp(java.lang.String imagePath)

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

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

Overrides:

cp in class BundlingDockerImage

Parameters:

imagePath - the path in the Docker image. This parameter is required.

Returns:

the destination path

run

public void run(DockerRunOptions options)

Runs a Docker image.

Overrides:

run in class BundlingDockerImage

Parameters:

options -

run

public void run()

Runs a Docker image.

Overrides:

run in class BundlingDockerImage

toJSON

public java.lang.String toJSON()

Provides a stable representation of this image for JSON serialization.

Overrides:

toJSON in class BundlingDockerImage

Returns:

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

getImage

public java.lang.String getImage()

The Docker image.

Overrides:

getImage in class BundlingDockerImage