Package software.amazon.awscdk

Class DockerBuildOptions.Builder

java.lang.Object

software.amazon.awscdk.DockerBuildOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DockerBuildOptions>

Enclosing interface:

DockerBuildOptions

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

A builder for DockerBuildOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DockerBuildOptions	build()	Builds the configured instance.
DockerBuildOptions.Builder	buildArgs(Map<String,String> buildArgs)	Sets the value of DockerBuildOptions.getBuildArgs()
DockerBuildOptions.Builder	cacheDisabled(Boolean cacheDisabled)	Sets the value of DockerBuildOptions.getCacheDisabled()
DockerBuildOptions.Builder	cacheFrom(List<? extends DockerCacheOption> cacheFrom)	Sets the value of DockerBuildOptions.getCacheFrom()
DockerBuildOptions.Builder	cacheTo(DockerCacheOption cacheTo)	Sets the value of DockerBuildOptions.getCacheTo()
DockerBuildOptions.Builder	file(String file)	Sets the value of DockerBuildOptions.getFile()
DockerBuildOptions.Builder	platform(String platform)	Sets the value of DockerBuildOptions.getPlatform()
DockerBuildOptions.Builder	targetStage(String targetStage)	Sets the value of DockerBuildOptions.getTargetStage()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

buildArgs

@Stability(Stable)
public DockerBuildOptions.Builder buildArgs(Map<String,String> buildArgs)

Sets the value of DockerBuildOptions.getBuildArgs()

Parameters:

buildArgs - Build args.

Returns:

this

cacheDisabled

@Stability(Stable)
public DockerBuildOptions.Builder cacheDisabled(Boolean cacheDisabled)

Sets the value of DockerBuildOptions.getCacheDisabled()

Parameters:

cacheDisabled - Disable the cache and pass --no-cache to the docker build command.

Returns:

this

cacheFrom

@Stability(Stable)
public DockerBuildOptions.Builder cacheFrom(List<? extends DockerCacheOption> cacheFrom)

Sets the value of DockerBuildOptions.getCacheFrom()

Parameters:

cacheFrom - Cache from options to pass to the docker build command.

Returns:

this

cacheTo

@Stability(Stable)
public DockerBuildOptions.Builder cacheTo(DockerCacheOption cacheTo)

Sets the value of DockerBuildOptions.getCacheTo()

Parameters:

cacheTo - Cache to options to pass to the docker build command.

Returns:

this

file

@Stability(Stable)
public DockerBuildOptions.Builder file(String file)

Sets the value of DockerBuildOptions.getFile()

Parameters:

file - Name of the Dockerfile, must relative to the docker build path.

Returns:

this

platform

@Stability(Stable)
public DockerBuildOptions.Builder platform(String platform)

Sets the value of DockerBuildOptions.getPlatform()

Parameters:

platform - Set platform if server is multi-platform capable. Requires Docker Engine API v1.38+. Example value: linux/amd64

Returns:

this

targetStage

@Stability(Stable)
public DockerBuildOptions.Builder targetStage(String targetStage)

Sets the value of DockerBuildOptions.getTargetStage()

Parameters:

targetStage - Set build target for multi-stage container builds. Any stage defined afterwards will be ignored. Example value: build-env

Returns:

this

build

@Stability(Stable)
public DockerBuildOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DockerBuildOptions

Throws:

NullPointerException - if any required attribute was not provided