software.amazon.awscdk.services.ecs

Class AssetImage.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.AssetImage.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AssetImage>

Enclosing class:

AssetImage

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

A fluent builder for AssetImage.

Method Summary

Modifier and Type	Method and Description
AssetImage	build()
AssetImage.Builder	buildArgs(Map<String,String> buildArgs) Build args to pass to the `docker build` command.
static AssetImage.Builder	create(String directory)
AssetImage.Builder	exclude(List<String> exclude) File paths matching the patterns will be excluded.
AssetImage.Builder	extraHash(String extraHash) Extra information to encode into the fingerprint (e.g.
AssetImage.Builder	file(String file) Path to the Dockerfile (relative to the directory).
AssetImage.Builder	followSymlinks(SymlinkFollowMode followSymlinks) A strategy for how to handle symlinks.
AssetImage.Builder	ignoreMode(IgnoreMode ignoreMode) The ignore behavior to use for `exclude` patterns.
AssetImage.Builder	invalidation(DockerImageAssetInvalidationOptions invalidation) Options to control which parameters are used to invalidate the asset hash.
AssetImage.Builder	networkMode(NetworkMode networkMode) Networking mode for the RUN commands during build.
AssetImage.Builder	platform(Platform platform) Platform to build for.
AssetImage.Builder	target(String target) Docker target to build to.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static AssetImage.Builder create(String directory)

Parameters:

directory - The directory containing the Dockerfile. This parameter is required.

Returns:

a new instance of AssetImage.Builder.

exclude

@Stability(value=Stable)
public AssetImage.Builder exclude(List<String> 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.

Default: - nothing is excluded

Parameters:

exclude - File paths matching the patterns will be excluded. This parameter is required.

Returns:

this

followSymlinks

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

A strategy for how to handle symlinks.

Default: SymlinkFollowMode.NEVER

Parameters:

followSymlinks - A strategy for how to handle symlinks. This parameter is required.

Returns:

this

ignoreMode

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

The ignore behavior to use for `exclude` patterns.

Default: IgnoreMode.GLOB

Parameters:

ignoreMode - The ignore behavior to use for `exclude` patterns. This parameter is required.

Returns:

this

extraHash

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

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

Default: - hash is only based on source content

Parameters:

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

Returns:

this

buildArgs

@Stability(value=Stable)
public AssetImage.Builder buildArgs(Map<String,String> 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).

Default: - no build args are passed

Parameters:

buildArgs - Build args to pass to the `docker build` command. This parameter is required.

Returns:

this

file

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

Path to the Dockerfile (relative to the directory).

Default: 'Dockerfile'

Parameters:

file - Path to the Dockerfile (relative to the directory). This parameter is required.

Returns:

this

invalidation

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

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

Default: - hash all parameters

Parameters:

invalidation - Options to control which parameters are used to invalidate the asset hash. This parameter is required.

Returns:

this

networkMode

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

Networking mode for the RUN commands during build.

Support docker API 1.25+.

Default: - no networking mode specified (the default networking mode `NetworkMode.DEFAULT` will be used)

Parameters:

networkMode - Networking mode for the RUN commands during build. This parameter is required.

Returns:

this

platform

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

Platform to build for.

Requires Docker Buildx.

Default: - no platform specified (the current machine architecture will be used)

Parameters:

platform - Platform to build for. This parameter is required.

Returns:

this

target

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

Docker target to build to.

Default: - no target

Parameters:

target - Docker target to build to. This parameter is required.

Returns:

this

build

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

Specified by:

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