Package 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.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:54.674Z")
@Stability(Stable)
public interface DockerImageSource
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cloudassembly.schema.*;
 DockerImageSource dockerImageSource = DockerImageSource.builder()
         .directory("directory")
         .dockerBuildArgs(Map.of(
                 "dockerBuildArgsKey", "dockerBuildArgs"))
         .dockerBuildTarget("dockerBuildTarget")
         .dockerFile("dockerFile")
         .executable(List.of("executable"))
         .networkMode("networkMode")
         .platform("platform")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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.
default String	getNetworkMode()	Networking mode for the RUN commands during build.
default String	getPlatform()	Platform to build for.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDirectory

@Stability(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(Stable)
@Nullable
default Map<String,String> getDockerBuildArgs()

Additional build arguments.

Only allowed when directory is set.

Default: - No additional build arguments

getDockerBuildTarget

@Stability(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(Stable)
@Nullable
default String getDockerFile()

The name of the file with build instructions.

Only allowed when directory is set.

Default: "Dockerfile"

getExecutable

@Stability(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

getNetworkMode

@Stability(Stable)
@Nullable
default String getNetworkMode()

Networking mode for the RUN commands during build. Requires Docker Engine API v1.25+.

Specify this property to build images on a specific networking mode.

Default: - no networking mode specified

getPlatform

@Stability(Stable)
@Nullable
default String getPlatform()

Platform to build for. Requires Docker Buildx.

Specify this property to build images on a specific platform/architecture.

Default: - current machine platform

builder

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

Returns:

a DockerImageSource.Builder of DockerImageSource