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
-
Method Summary
Modifier and TypeMethodDescriptionSets the value ofDockerImageAssetOptions.getAssetName()
build()
Builds the configured instance.Sets the value ofDockerImageAssetOptions.getBuildArgs()
buildSecrets
(Map<String, String> buildSecrets) Sets the value ofDockerImageAssetOptions.getBuildSecrets()
Sets the value ofDockerImageAssetOptions.getBuildSsh()
cacheDisabled
(Boolean cacheDisabled) Sets the value ofDockerImageAssetOptions.getCacheDisabled()
cacheFrom
(List<? extends DockerCacheOption> cacheFrom) Sets the value ofDockerImageAssetOptions.getCacheFrom()
cacheTo
(DockerCacheOption cacheTo) Sets the value ofDockerImageAssetOptions.getCacheTo()
Sets the value ofDockerImageAssetProps.getDirectory()
Sets the value ofFileCopyOptions.getExclude()
Sets the value ofFileFingerprintOptions.getExtraHash()
Sets the value ofDockerImageAssetOptions.getFile()
followSymlinks
(SymlinkFollowMode followSymlinks) Sets the value ofFileCopyOptions.getFollowSymlinks()
ignoreMode
(IgnoreMode ignoreMode) Sets the value ofFileCopyOptions.getIgnoreMode()
invalidation
(DockerImageAssetInvalidationOptions invalidation) Sets the value ofDockerImageAssetOptions.getInvalidation()
networkMode
(NetworkMode networkMode) Sets the value ofDockerImageAssetOptions.getNetworkMode()
Sets the value ofDockerImageAssetOptions.getOutputs()
Sets the value ofDockerImageAssetOptions.getPlatform()
Sets the value ofDockerImageAssetOptions.getTarget()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
directory
Sets the value ofDockerImageAssetProps.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
-
assetName
Sets the value ofDockerImageAssetOptions.getAssetName()
- Parameters:
assetName
- Unique identifier of the docker image asset and its potential revisions. Required if using AppScopedStagingSynthesizer.- Returns:
this
-
buildArgs
Sets the value ofDockerImageAssetOptions.getBuildArgs()
- Parameters:
buildArgs
- Build args to pass to thedocker build
command. Since Docker build arguments are resolved before deployment, keys and values cannot refer to unresolved tokens (such aslambda.functionArn
orqueue.queueUrl
).- Returns:
this
-
buildSecrets
@Stability(Stable) public DockerImageAssetProps.Builder buildSecrets(Map<String, String> buildSecrets) Sets the value ofDockerImageAssetOptions.getBuildSecrets()
- Parameters:
buildSecrets
- Build secrets. Docker BuildKit must be enabled to use build secrets.- Returns:
this
-
buildSsh
Sets the value ofDockerImageAssetOptions.getBuildSsh()
- Parameters:
buildSsh
- SSH agent socket or keys to pass to thedocker build
command. Docker BuildKit must be enabled to use the ssh flag- Returns:
this
-
cacheDisabled
Sets the value ofDockerImageAssetOptions.getCacheDisabled()
- Parameters:
cacheDisabled
- Disable the cache and pass--no-cache
to thedocker build
command.- Returns:
this
-
cacheFrom
@Stability(Stable) public DockerImageAssetProps.Builder cacheFrom(List<? extends DockerCacheOption> cacheFrom) Sets the value ofDockerImageAssetOptions.getCacheFrom()
- Parameters:
cacheFrom
- Cache from options to pass to thedocker build
command.- Returns:
this
-
cacheTo
Sets the value ofDockerImageAssetOptions.getCacheTo()
- Parameters:
cacheTo
- Cache to options to pass to thedocker build
command.- Returns:
this
-
file
Sets the value ofDockerImageAssetOptions.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 ofDockerImageAssetOptions.getInvalidation()
- Parameters:
invalidation
- Options to control which parameters are used to invalidate the asset hash.- Returns:
this
-
networkMode
Sets the value ofDockerImageAssetOptions.getNetworkMode()
- Parameters:
networkMode
- Networking mode for the RUN commands during build. Support docker API 1.25+.- Returns:
this
-
outputs
Sets the value ofDockerImageAssetOptions.getOutputs()
- Parameters:
outputs
- Outputs to pass to thedocker build
command.- Returns:
this
-
platform
Sets the value ofDockerImageAssetOptions.getPlatform()
- Parameters:
platform
- Platform to build for. Requires Docker Buildx.- Returns:
this
-
target
Sets the value ofDockerImageAssetOptions.getTarget()
- Parameters:
target
- Docker target to build to.- Returns:
this
-
extraHash
Sets the value ofFileFingerprintOptions.getExtraHash()
- Parameters:
extraHash
- Extra information to encode into the fingerprint (e.g. build instructions and other inputs).- Returns:
this
-
exclude
Sets the value ofFileCopyOptions.getExclude()
- Parameters:
exclude
- File paths matching the patterns will be excluded. SeeignoreMode
to set the matching behavior. Has no effect on Assets bundled using thebundling
property.- Returns:
this
-
followSymlinks
@Stability(Stable) public DockerImageAssetProps.Builder followSymlinks(SymlinkFollowMode followSymlinks) Sets the value ofFileCopyOptions.getFollowSymlinks()
- Parameters:
followSymlinks
- A strategy for how to handle symlinks.- Returns:
this
-
ignoreMode
Sets the value ofFileCopyOptions.getIgnoreMode()
- Parameters:
ignoreMode
- The ignore behavior to use forexclude
patterns.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<DockerImageAssetProps>
- Returns:
- a new instance of
DockerImageAssetProps
- Throws:
NullPointerException
- if any required attribute was not provided
-