software.amazon.awscdk.services.ecr.assets

Class DockerImageAsset.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<DockerImageAsset>

Enclosing class:

DockerImageAsset

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

(experimental) A fluent builder for DockerImageAsset.

Method Summary

Modifier and Type	Method and Description
DockerImageAsset	build()
DockerImageAsset.Builder	buildArgs(Map<String,String> buildArgs) (experimental) Build args to pass to the `docker build` command.
static DockerImageAsset.Builder	create(software.constructs.Construct scope, String id)
DockerImageAsset.Builder	directory(String directory) (experimental) The directory where the Dockerfile is stored.
DockerImageAsset.Builder	exclude(List<String> exclude) Deprecated.
DockerImageAsset.Builder	extraHash(String extraHash) Deprecated.
DockerImageAsset.Builder	file(String file) (experimental) Path to the Dockerfile (relative to the directory).
DockerImageAsset.Builder	follow(FollowMode follow) Deprecated.
DockerImageAsset.Builder	ignoreMode(IgnoreMode ignoreMode) Deprecated.
DockerImageAsset.Builder	repositoryName(String repositoryName) Deprecated. to control the location of docker image assets, please override `Stack.addDockerImageAsset`. this feature will be removed in future releases.
DockerImageAsset.Builder	target(String target) (experimental) 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=Experimental)
public static DockerImageAsset.Builder create(software.constructs.Construct scope,
                                                                             String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of DockerImageAsset.Builder.

exclude

@Stability(value=Deprecated)
 @Deprecated
public DockerImageAsset.Builder exclude(List<String> exclude)

Deprecated.

(deprecated) Glob patterns to exclude from the copy.

Default: nothing is excluded

Parameters:

exclude - Glob patterns to exclude from the copy. This parameter is required.

Returns:

this

follow

@Stability(value=Deprecated)
 @Deprecated
public DockerImageAsset.Builder follow(FollowMode follow)

Deprecated.

(deprecated) A strategy for how to handle symlinks.

Default: Never

Parameters:

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

Returns:

this

ignoreMode

@Stability(value=Deprecated)
 @Deprecated
public DockerImageAsset.Builder ignoreMode(IgnoreMode ignoreMode)

Deprecated.

(deprecated) The ignore behavior to use for exclude patterns.

Default: - GLOB for file assets, DOCKER or GLOB for docker assets depending on whether the '

Parameters:

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

Returns:

this

extraHash

@Stability(value=Deprecated)
 @Deprecated
public DockerImageAsset.Builder extraHash(String extraHash)

Deprecated.

(deprecated) 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=Experimental)
public DockerImageAsset.Builder buildArgs(Map<String,String> buildArgs)

(experimental) 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=Experimental)
public DockerImageAsset.Builder file(String file)

(experimental) 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

repositoryName

@Stability(value=Deprecated)
 @Deprecated
public DockerImageAsset.Builder repositoryName(String repositoryName)

Deprecated. to control the location of docker image assets, please override `Stack.addDockerImageAsset`. this feature will be removed in future releases.

(deprecated) ECR repository name.

Specify this property if you need to statically address the image, e.g. from a Kubernetes Pod. Note, this is only the repository name, without the registry and the tag parts.

Default: - the default ECR repository for CDK assets

Parameters:

repositoryName - ECR repository name. This parameter is required.

Returns:

this

target

@Stability(value=Experimental)
public DockerImageAsset.Builder target(String target)

(experimental) Docker target to build to.

Default: - no target

Parameters:

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

Returns:

this

directory

@Stability(value=Experimental)
public DockerImageAsset.Builder directory(String directory)

(experimental) The directory where the Dockerfile is stored.

Parameters:

directory - The directory where the Dockerfile is stored. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public DockerImageAsset build()

Specified by:

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