Package software.amazon.awscdk.services.lambda

Class DockerBuildAssetOptions.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.DockerBuildAssetOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DockerBuildAssetOptions>

Enclosing interface:

DockerBuildAssetOptions

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

A builder for DockerBuildAssetOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DockerBuildAssetOptions	build()	Builds the configured instance.
DockerBuildAssetOptions.Builder	buildArgs(Map<String,String> buildArgs)	Sets the value of DockerBuildOptions.getBuildArgs()
DockerBuildAssetOptions.Builder	cacheDisabled(Boolean cacheDisabled)	Sets the value of DockerBuildOptions.getCacheDisabled()
DockerBuildAssetOptions.Builder	cacheFrom(List<? extends DockerCacheOption> cacheFrom)	Sets the value of DockerBuildOptions.getCacheFrom()
DockerBuildAssetOptions.Builder	cacheTo(DockerCacheOption cacheTo)	Sets the value of DockerBuildOptions.getCacheTo()
DockerBuildAssetOptions.Builder	file(String file)	Sets the value of DockerBuildOptions.getFile()
DockerBuildAssetOptions.Builder	imagePath(String imagePath)	Sets the value of DockerBuildAssetOptions.getImagePath()
DockerBuildAssetOptions.Builder	network(String network)	Sets the value of DockerBuildOptions.getNetwork()
DockerBuildAssetOptions.Builder	outputPath(String outputPath)	Sets the value of DockerBuildAssetOptions.getOutputPath()
DockerBuildAssetOptions.Builder	platform(String platform)	Sets the value of DockerBuildOptions.getPlatform()
DockerBuildAssetOptions.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

imagePath

@Stability(Stable)
public DockerBuildAssetOptions.Builder imagePath(String imagePath)

Sets the value of DockerBuildAssetOptions.getImagePath()

Parameters:

imagePath - The path in the Docker image where the asset is located after the build operation.

Returns:

this

outputPath

@Stability(Stable)
public DockerBuildAssetOptions.Builder outputPath(String outputPath)

Sets the value of DockerBuildAssetOptions.getOutputPath()

Parameters:

outputPath - The path on the local filesystem where the asset will be copied using docker cp.

Returns:

this

buildArgs

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

Sets the value of DockerBuildOptions.getBuildArgs()

Parameters:

buildArgs - Build args.

Returns:

this

cacheDisabled

@Stability(Stable)
public DockerBuildAssetOptions.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 DockerBuildAssetOptions.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 DockerBuildAssetOptions.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 DockerBuildAssetOptions.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

network

@Stability(Stable)
public DockerBuildAssetOptions.Builder network(String network)

Sets the value of DockerBuildOptions.getNetwork()

Parameters:

network - Docker Networking options.

Returns:

this

platform

@Stability(Stable)
public DockerBuildAssetOptions.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 DockerBuildAssetOptions.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 DockerBuildAssetOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DockerBuildAssetOptions

Throws:

NullPointerException - if any required attribute was not provided