Package 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(Stable)
public static final class DockerImageAssetProps.Builder
extends Object
implements software.amazon.jsii.Builder<DockerImageAssetProps>

A builder for DockerImageAssetProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	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 DockerImageAssetOptions.getExclude()
DockerImageAssetProps.Builder	extraHash(String extraHash)	Sets the value of DockerImageAssetOptions.getExtraHash()
DockerImageAssetProps.Builder	file(String file)	Sets the value of DockerImageAssetOptions.getFile()
DockerImageAssetProps.Builder	follow(FollowMode follow)	Deprecated. use `followSymlinks` instead
DockerImageAssetProps.Builder	followSymlinks(SymlinkFollowMode followSymlinks)	Sets the value of FileCopyOptions.getFollowSymlinks()
DockerImageAssetProps.Builder	ignoreMode(IgnoreMode ignoreMode)	Sets the value of DockerImageAssetOptions.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	repositoryName(String repositoryName)	Deprecated. to control the location of docker image assets, please override `Stack.addDockerImageAsset`.
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 Details

Builder

public Builder()

Method Details

directory

@Stability(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(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(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(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(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(Stable)
public DockerImageAssetProps.Builder platform(Platform platform)

Sets the value of DockerImageAssetOptions.getPlatform()

Parameters:

platform - Platform to build for. Requires Docker Buildx.

Returns:

this

repositoryName

@Stability(Deprecated)
@Deprecated
public DockerImageAssetProps.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.

Sets the value of DockerImageAssetOptions.getRepositoryName()

Parameters:

repositoryName - 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.

Returns:

this

target

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

Sets the value of DockerImageAssetOptions.getTarget()

Parameters:

target - Docker target to build to.

Returns:

this

extraHash

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

Sets the value of DockerImageAssetOptions.getExtraHash()

Parameters:

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

Returns:

this

exclude

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

Sets the value of DockerImageAssetOptions.getExclude()

Parameters:

exclude - Glob patterns to exclude from the copy.

Returns:

this

follow

@Stability(Deprecated)
@Deprecated
public DockerImageAssetProps.Builder follow(FollowMode follow)

Deprecated.

use `followSymlinks` instead

Sets the value of CopyOptions.getFollow()

Parameters:

follow - A strategy for how to handle symlinks.

Returns:

this

ignoreMode

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

Sets the value of DockerImageAssetOptions.getIgnoreMode()

Parameters:

ignoreMode - The ignore behavior to use for exclude patterns.

Returns:

this

followSymlinks

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

Sets the value of FileCopyOptions.getFollowSymlinks()

Parameters:

followSymlinks - A strategy for how to handle symlinks.

Returns:

this

build

@Stability(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