software.amazon.awscdk.cloudassembly.schema

Interface DockerImageSource

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DockerImageSource.Jsii$Proxy

@Generated(value="jsii-pacmak/1.34.0 (build 9b72778)",
           date="2021-09-01T11:09:03.099Z")
 @Stability(value=Stable)
public interface DockerImageSource
extends software.amazon.jsii.JsiiSerializable

Properties for how to produce a Docker image from a source.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DockerImageSource.Builder A builder for DockerImageSource
static class	DockerImageSource.Jsii$Proxy An implementation for DockerImageSource

Method Summary

Modifier and Type	Method and Description
static DockerImageSource.Builder	builder()
default String	getDirectory() The directory containing the Docker image build instructions.
default Map<String,String>	getDockerBuildArgs() Additional build arguments.
default String	getDockerBuildTarget() Target build stage in a Dockerfile with multiple build stages.
default String	getDockerFile() The name of the file with build instructions.
default List<String>	getExecutable() A command-line executable that returns the name of a local Docker image on stdout after being run.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDirectory

@Stability(value=Stable)
 @Nullable
default String getDirectory()

The directory containing the Docker image build instructions.

This path is relative to the asset manifest location.

Default: - Exactly one of `directory` and `executable` is required

getDockerBuildArgs

@Stability(value=Stable)
 @Nullable
default Map<String,String> getDockerBuildArgs()

Additional build arguments.

Only allowed when directory is set.

Default: - No additional build arguments

getDockerBuildTarget

@Stability(value=Stable)
 @Nullable
default String getDockerBuildTarget()

Target build stage in a Dockerfile with multiple build stages.

Only allowed when directory is set.

Default: - The last stage in the Dockerfile

getDockerFile

@Stability(value=Stable)
 @Nullable
default String getDockerFile()

The name of the file with build instructions.

Only allowed when directory is set.

Default: "Dockerfile"

getExecutable

@Stability(value=Stable)
 @Nullable
default List<String> getExecutable()

A command-line executable that returns the name of a local Docker image on stdout after being run.

Default: - Exactly one of `directory` and `executable` is required

builder

@Stability(value=Stable)
static DockerImageSource.Builder builder()

Returns:

a DockerImageSource.Builder of DockerImageSource