software.amazon.awscdk.cloudassembly.schema

Class DockerImageSource.Builder

java.lang.Object

software.amazon.awscdk.cloudassembly.schema.DockerImageSource.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DockerImageSource>

Enclosing interface:

DockerImageSource

@Stability(value=Stable)
public static final class DockerImageSource.Builder
extends Object
implements software.amazon.jsii.Builder<DockerImageSource>

A builder for DockerImageSource

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DockerImageSource	build() Builds the configured instance.
DockerImageSource.Builder	directory(String directory) Sets the value of DockerImageSource.getDirectory()
DockerImageSource.Builder	dockerBuildArgs(Map<String,String> dockerBuildArgs) Sets the value of DockerImageSource.getDockerBuildArgs()
DockerImageSource.Builder	dockerBuildTarget(String dockerBuildTarget) Sets the value of DockerImageSource.getDockerBuildTarget()
DockerImageSource.Builder	dockerFile(String dockerFile) Sets the value of DockerImageSource.getDockerFile()
DockerImageSource.Builder	executable(List<String> executable) Sets the value of DockerImageSource.getExecutable()
DockerImageSource.Builder	networkMode(String networkMode) Sets the value of DockerImageSource.getNetworkMode()
DockerImageSource.Builder	platform(String platform) Sets the value of DockerImageSource.getPlatform()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

directory

@Stability(value=Stable)
public DockerImageSource.Builder directory(String directory)

Sets the value of DockerImageSource.getDirectory()

Parameters:

directory - The directory containing the Docker image build instructions. This path is relative to the asset manifest location.

Returns:

this

dockerBuildArgs

@Stability(value=Stable)
public DockerImageSource.Builder dockerBuildArgs(Map<String,String> dockerBuildArgs)

Sets the value of DockerImageSource.getDockerBuildArgs()

Parameters:

dockerBuildArgs - Additional build arguments. Only allowed when directory is set.

Returns:

this

dockerBuildTarget

@Stability(value=Stable)
public DockerImageSource.Builder dockerBuildTarget(String dockerBuildTarget)

Sets the value of DockerImageSource.getDockerBuildTarget()

Parameters:

dockerBuildTarget - Target build stage in a Dockerfile with multiple build stages. Only allowed when directory is set.

Returns:

this

dockerFile

@Stability(value=Stable)
public DockerImageSource.Builder dockerFile(String dockerFile)

Sets the value of DockerImageSource.getDockerFile()

Parameters:

dockerFile - The name of the file with build instructions. Only allowed when directory is set.

Returns:

this

executable

@Stability(value=Stable)
public DockerImageSource.Builder executable(List<String> executable)

Sets the value of DockerImageSource.getExecutable()

Parameters:

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

Returns:

this

networkMode

@Stability(value=Stable)
public DockerImageSource.Builder networkMode(String networkMode)

Sets the value of DockerImageSource.getNetworkMode()

Parameters:

networkMode - 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.

Returns:

this

platform

@Stability(value=Stable)
public DockerImageSource.Builder platform(String platform)

Sets the value of DockerImageSource.getPlatform()

Parameters:

platform - Platform to build for. _Requires Docker Buildx_. Specify this property to build images on a specific platform/architecture.

Returns:

this

build

@Stability(value=Stable)
public DockerImageSource build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<DockerImageSource>

Returns:

a new instance of DockerImageSource

Throws:

NullPointerException - if any required attribute was not provided