Package 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

Direct Known Subclasses:

DockerImage

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:54.815Z")
@Stability(Deprecated)
@Deprecated
public class BundlingDockerImage
extends software.amazon.jsii.JsiiObject

Deprecated.

use DockerImage

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

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

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

Method Summary

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

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 Details

BundlingDockerImage

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

Deprecated.

BundlingDockerImage

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

Deprecated.

BundlingDockerImage

@Stability(Deprecated)
@Deprecated
protected BundlingDockerImage(@NotNull
 String image,
 @Nullable
 String _imageHash)

Deprecated.

Parameters:

image - The Docker image. This parameter is required.

_imageHash -

BundlingDockerImage

@Stability(Deprecated)
@Deprecated
protected BundlingDockerImage(@NotNull
 String image)

Deprecated.

Parameters:

image - The Docker image. This parameter is required.

Method Details

fromAsset

@Stability(Deprecated)
@Deprecated
@NotNull
public static BundlingDockerImage fromAsset(@NotNull
 String path,
 @Nullable
 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

@Stability(Deprecated)
@Deprecated
@NotNull
public static BundlingDockerImage fromAsset(@NotNull
 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

@Stability(Deprecated)
@Deprecated
@NotNull
public static DockerImage fromRegistry(@NotNull
 String image)

Deprecated.

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

Parameters:

image - the image name. This parameter is required.

cp

@Stability(Deprecated)
@Deprecated
@NotNull
public String cp(@NotNull
 String imagePath,
 @Nullable
 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

@Stability(Deprecated)
@Deprecated
@NotNull
public String cp(@NotNull
 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

@Stability(Deprecated)
@Deprecated
public void run(@Nullable
 DockerRunOptions options)

Deprecated.

(deprecated) Runs a Docker image.

Parameters:

options -

run

@Stability(Deprecated)
@Deprecated
public void run()

Deprecated.

(deprecated) Runs a Docker image.

toJSON

@Stability(Deprecated)
@Deprecated
@NotNull
public 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

@Stability(Deprecated)
@Deprecated
@NotNull
public String getImage()

Deprecated.

(deprecated) The Docker image.