Package software.amazon.awscdk

Class DockerImageAssetSource.Builder

java.lang.Object

software.amazon.awscdk.DockerImageAssetSource.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DockerImageAssetSource>

Enclosing interface:

DockerImageAssetSource

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

A builder for DockerImageAssetSource

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DockerImageAssetSource.Builder	assetName(String assetName)	Sets the value of DockerImageAssetSource.getAssetName()
DockerImageAssetSource	build()	Builds the configured instance.
DockerImageAssetSource.Builder	directoryName(String directoryName)	Sets the value of DockerImageAssetSource.getDirectoryName()
DockerImageAssetSource.Builder	dockerBuildArgs(Map<String,String> dockerBuildArgs)	Sets the value of DockerImageAssetSource.getDockerBuildArgs()
DockerImageAssetSource.Builder	dockerBuildSecrets(Map<String,String> dockerBuildSecrets)	Sets the value of DockerImageAssetSource.getDockerBuildSecrets()
DockerImageAssetSource.Builder	dockerBuildSsh(String dockerBuildSsh)	Sets the value of DockerImageAssetSource.getDockerBuildSsh()
DockerImageAssetSource.Builder	dockerBuildTarget(String dockerBuildTarget)	Sets the value of DockerImageAssetSource.getDockerBuildTarget()
DockerImageAssetSource.Builder	dockerCacheDisabled(Boolean dockerCacheDisabled)	Sets the value of DockerImageAssetSource.getDockerCacheDisabled()
DockerImageAssetSource.Builder	dockerCacheFrom(List<? extends DockerCacheOption> dockerCacheFrom)	Sets the value of DockerImageAssetSource.getDockerCacheFrom()
DockerImageAssetSource.Builder	dockerCacheTo(DockerCacheOption dockerCacheTo)	Sets the value of DockerImageAssetSource.getDockerCacheTo()
DockerImageAssetSource.Builder	dockerFile(String dockerFile)	Sets the value of DockerImageAssetSource.getDockerFile()
DockerImageAssetSource.Builder	dockerOutputs(List<String> dockerOutputs)	Sets the value of DockerImageAssetSource.getDockerOutputs()
DockerImageAssetSource.Builder	executable(List<String> executable)	Sets the value of DockerImageAssetSource.getExecutable()
DockerImageAssetSource.Builder	networkMode(String networkMode)	Sets the value of DockerImageAssetSource.getNetworkMode()
DockerImageAssetSource.Builder	platform(String platform)	Sets the value of DockerImageAssetSource.getPlatform()
DockerImageAssetSource.Builder	sourceHash(String sourceHash)	Sets the value of DockerImageAssetSource.getSourceHash()

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

sourceHash

@Stability(Stable)
public DockerImageAssetSource.Builder sourceHash(String sourceHash)

Sets the value of DockerImageAssetSource.getSourceHash()

Parameters:

sourceHash - The hash of the contents of the docker build context. This parameter is required. This hash is used throughout the system to identify this image and avoid duplicate work in case the source did not change.

NOTE: this means that if you wish to update your docker image, you must make a modification to the source (e.g. add some metadata to your Dockerfile).

Returns:

this

assetName

@Stability(Stable)
public DockerImageAssetSource.Builder assetName(String assetName)

Sets the value of DockerImageAssetSource.getAssetName()

Parameters:

assetName - Unique identifier of the docker image asset and its potential revisions. Required if using AppScopedStagingSynthesizer.

Returns:

this

directoryName

@Stability(Stable)
public DockerImageAssetSource.Builder directoryName(String directoryName)

Sets the value of DockerImageAssetSource.getDirectoryName()

Parameters:

directoryName - The directory where the Dockerfile is stored, must be relative to the cloud assembly root.

Returns:

this

dockerBuildArgs

@Stability(Stable)
public DockerImageAssetSource.Builder dockerBuildArgs(Map<String,String> dockerBuildArgs)

Sets the value of DockerImageAssetSource.getDockerBuildArgs()

Parameters:

dockerBuildArgs - Build args to pass to the docker build command. Since Docker build arguments are resolved before deployment, keys and values cannot refer to unresolved tokens (such as lambda.functionArn or queue.queueUrl).

Only allowed when directoryName is specified.

Returns:

this

dockerBuildSecrets

@Stability(Stable)
public DockerImageAssetSource.Builder dockerBuildSecrets(Map<String,String> dockerBuildSecrets)

Sets the value of DockerImageAssetSource.getDockerBuildSecrets()

Parameters:

dockerBuildSecrets - Build secrets to pass to the docker build command. Since Docker build secrets are resolved before deployment, keys and values cannot refer to unresolved tokens (such as lambda.functionArn or queue.queueUrl).

Only allowed when directoryName is specified.

Returns:

this

dockerBuildSsh

@Stability(Stable)
public DockerImageAssetSource.Builder dockerBuildSsh(String dockerBuildSsh)

Sets the value of DockerImageAssetSource.getDockerBuildSsh()

Parameters:

dockerBuildSsh - SSH agent socket or keys to pass to the docker buildx command.

Returns:

this

dockerBuildTarget

@Stability(Stable)
public DockerImageAssetSource.Builder dockerBuildTarget(String dockerBuildTarget)

Sets the value of DockerImageAssetSource.getDockerBuildTarget()

Parameters:

dockerBuildTarget - Docker target to build to. Only allowed when directoryName is specified.

Returns:

this

dockerCacheDisabled

@Stability(Stable)
public DockerImageAssetSource.Builder dockerCacheDisabled(Boolean dockerCacheDisabled)

Sets the value of DockerImageAssetSource.getDockerCacheDisabled()

Parameters:

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

Returns:

this

dockerCacheFrom

@Stability(Stable)
public DockerImageAssetSource.Builder dockerCacheFrom(List<? extends DockerCacheOption> dockerCacheFrom)

Sets the value of DockerImageAssetSource.getDockerCacheFrom()

Parameters:

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

Returns:

this

dockerCacheTo

@Stability(Stable)
public DockerImageAssetSource.Builder dockerCacheTo(DockerCacheOption dockerCacheTo)

Sets the value of DockerImageAssetSource.getDockerCacheTo()

Parameters:

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

Returns:

this

dockerFile

@Stability(Stable)
public DockerImageAssetSource.Builder dockerFile(String dockerFile)

Sets the value of DockerImageAssetSource.getDockerFile()

Parameters:

dockerFile - Path to the Dockerfile (relative to the directory). Only allowed when directoryName is specified.

Returns:

this

dockerOutputs

@Stability(Stable)
public DockerImageAssetSource.Builder dockerOutputs(List<String> dockerOutputs)

Sets the value of DockerImageAssetSource.getDockerOutputs()

Parameters:

dockerOutputs - Outputs to pass to the docker build command.

Returns:

this

executable

@Stability(Stable)
public DockerImageAssetSource.Builder executable(List<String> executable)

Sets the value of DockerImageAssetSource.getExecutable()

Parameters:

executable - An external command that will produce the packaged asset. The command should produce the name of a local Docker image on stdout.

Returns:

this

networkMode

@Stability(Stable)
public DockerImageAssetSource.Builder networkMode(String networkMode)

Sets the value of DockerImageAssetSource.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(Stable)
public DockerImageAssetSource.Builder platform(String platform)

Sets the value of DockerImageAssetSource.getPlatform()

Parameters:

platform - Platform to build for. Requires Docker Buildx. Specify this property to build images on a specific platform.

Returns:

this

build

@Stability(Stable)
public DockerImageAssetSource build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DockerImageAssetSource

Throws:

NullPointerException - if any required attribute was not provided