software.amazon.awscdk.core

Class BundlingDockerImage

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.BundlingDockerImage

Direct Known Subclasses:

DockerImage

Deprecated.

use DockerImage

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:52.888Z")
 @Deprecated
public class BundlingDockerImage
extends software.amazon.jsii.JsiiObject

(deprecated) A Docker image used for asset bundling.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 BundlingDockerImage bundlingDockerImage = BundlingDockerImage.fromAsset("path", DockerBuildOptions.builder()
         .buildArgs(Map.of(
                 "buildArgsKey", "buildArgs"))
         .file("file")
         .platform("platform")
         .build());
 

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	cp(java.lang.String imagePath) Deprecated.
java.lang.String	cp(java.lang.String imagePath, java.lang.String outputPath) Deprecated.
static BundlingDockerImage	fromAsset(java.lang.String path) Deprecated. use DockerImage.fromBuild()
static BundlingDockerImage	fromAsset(java.lang.String path, DockerBuildOptions options) Deprecated. use DockerImage.fromBuild()
static DockerImage	fromRegistry(java.lang.String image) Deprecated.
java.lang.String	getImage() Deprecated.
void	run() Deprecated.
void	run(DockerRunOptions options) Deprecated.
java.lang.String	toJSON() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

BundlingDockerImage

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

Deprecated.

BundlingDockerImage

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

Deprecated.

BundlingDockerImage

@Deprecated
protected BundlingDockerImage(java.lang.String image,
                                          java.lang.String _imageHash)

Deprecated.

Parameters:

image - The Docker image. This parameter is required.

_imageHash -

Method Detail

fromAsset

@Deprecated
public static BundlingDockerImage fromAsset(java.lang.String path,
                                                        DockerBuildOptions options)

Deprecated. use DockerImage.fromBuild()

(deprecated) 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

@Deprecated
public static BundlingDockerImage fromAsset(java.lang.String path)

Deprecated. use DockerImage.fromBuild()

(deprecated) 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

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

Deprecated.

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

Parameters:

image - the image name. This parameter is required.

cp

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

Deprecated.

(deprecated) 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.

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

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

Deprecated.

(deprecated) 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.

Parameters:

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

Returns:

the destination path

run

@Deprecated
public void run(DockerRunOptions options)

Deprecated.

(deprecated) Runs a Docker image.

Parameters:

options -

run

@Deprecated
public void run()

Deprecated.

(deprecated) Runs a Docker image.

toJSON

@Deprecated
public java.lang.String toJSON()

Deprecated.

(deprecated) 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

@Deprecated
public java.lang.String getImage()

Deprecated.

(deprecated) The Docker image.