software.amazon.awscdk.services.ecr.assets

Class DockerImageAssetProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecr.assets.DockerImageAssetProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DockerImageAssetProps>

Enclosing interface:

DockerImageAssetProps

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

A builder for DockerImageAssetProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DockerImageAssetProps	build() Builds the configured instance.
DockerImageAssetProps.Builder	buildArgs(Map<String,String> buildArgs) Sets the value of DockerImageAssetOptions.getBuildArgs()
DockerImageAssetProps.Builder	directory(String directory) Sets the value of DockerImageAssetProps.getDirectory()
DockerImageAssetProps.Builder	exclude(List<String> exclude) Sets the value of FileCopyOptions.getExclude()
DockerImageAssetProps.Builder	extraHash(String extraHash) Sets the value of FileFingerprintOptions.getExtraHash()
DockerImageAssetProps.Builder	file(String file) Sets the value of DockerImageAssetOptions.getFile()
DockerImageAssetProps.Builder	followSymlinks(SymlinkFollowMode followSymlinks) Sets the value of FileCopyOptions.getFollowSymlinks()
DockerImageAssetProps.Builder	ignoreMode(IgnoreMode ignoreMode) Sets the value of FileCopyOptions.getIgnoreMode()
DockerImageAssetProps.Builder	invalidation(DockerImageAssetInvalidationOptions invalidation) Sets the value of DockerImageAssetOptions.getInvalidation()
DockerImageAssetProps.Builder	networkMode(NetworkMode networkMode) Sets the value of DockerImageAssetOptions.getNetworkMode()
DockerImageAssetProps.Builder	platform(Platform platform) Sets the value of DockerImageAssetOptions.getPlatform()
DockerImageAssetProps.Builder	target(String target) Sets the value of DockerImageAssetOptions.getTarget()

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 DockerImageAssetProps.Builder directory(String directory)

Sets the value of DockerImageAssetProps.getDirectory()

Parameters:

directory - The directory where the Dockerfile is stored. This parameter is required. Any directory inside with a name that matches the CDK output folder (cdk.out by default) will be excluded from the asset

Returns:

this

buildArgs

@Stability(value=Stable)
public DockerImageAssetProps.Builder buildArgs(Map<String,String> buildArgs)

Sets the value of DockerImageAssetOptions.getBuildArgs()

Parameters:

buildArgs - 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).

Returns:

this

file

@Stability(value=Stable)
public DockerImageAssetProps.Builder file(String file)

Sets the value of DockerImageAssetOptions.getFile()

Parameters:

file - Path to the Dockerfile (relative to the directory).

Returns:

this

invalidation

@Stability(value=Stable)
public DockerImageAssetProps.Builder invalidation(DockerImageAssetInvalidationOptions invalidation)

Sets the value of DockerImageAssetOptions.getInvalidation()

Parameters:

invalidation - Options to control which parameters are used to invalidate the asset hash.

Returns:

this

networkMode

@Stability(value=Stable)
public DockerImageAssetProps.Builder networkMode(NetworkMode networkMode)

Sets the value of DockerImageAssetOptions.getNetworkMode()

Parameters:

networkMode - Networking mode for the RUN commands during build. Support docker API 1.25+.

Returns:

this

platform

@Stability(value=Stable)
public DockerImageAssetProps.Builder platform(Platform platform)

Sets the value of DockerImageAssetOptions.getPlatform()

Parameters:

platform - Platform to build for. Requires Docker Buildx.

Returns:

this

target

@Stability(value=Stable)
public DockerImageAssetProps.Builder target(String target)

Sets the value of DockerImageAssetOptions.getTarget()

Parameters:

target - Docker target to build to.

Returns:

this

extraHash

@Stability(value=Stable)
public DockerImageAssetProps.Builder extraHash(String extraHash)

Sets the value of FileFingerprintOptions.getExtraHash()

Parameters:

extraHash - Extra information to encode into the fingerprint (e.g. build instructions and other inputs).

Returns:

this

exclude

@Stability(value=Stable)
public DockerImageAssetProps.Builder exclude(List<String> exclude)

Sets the value of FileCopyOptions.getExclude()

Parameters:

exclude - File paths matching the patterns will be excluded. See ignoreMode to set the matching behavior. Has no effect on Assets bundled using the bundling property.

Returns:

this

followSymlinks

@Stability(value=Stable)
public DockerImageAssetProps.Builder followSymlinks(SymlinkFollowMode followSymlinks)

Sets the value of FileCopyOptions.getFollowSymlinks()

Parameters:

followSymlinks - A strategy for how to handle symlinks.

Returns:

this

ignoreMode

@Stability(value=Stable)
public DockerImageAssetProps.Builder ignoreMode(IgnoreMode ignoreMode)

Sets the value of FileCopyOptions.getIgnoreMode()

Parameters:

ignoreMode - The ignore behavior to use for `exclude` patterns.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DockerImageAssetProps

Throws:

NullPointerException - if any required attribute was not provided