DockerImageAsset.Builder

java.lang.Object
- software.amazon.awscdk.services.ecr.assets.DockerImageAsset.Builder

Enclosing class:: DockerImageAsset

public static final class DockerImageAsset.Builder
extends java.lang.Object

A fluent builder for DockerImageAsset.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DockerImageAsset`	`build()`
`DockerImageAsset.Builder`	`buildArgs(java.util.Map<java.lang.String,java.lang.String> buildArgs)` Build args to pass to the `docker build` command.
`static DockerImageAsset.Builder`	`create(software.constructs.Construct scope, java.lang.String id)`
`DockerImageAsset.Builder`	`directory(java.lang.String directory)` The directory where the Dockerfile is stored.
`DockerImageAsset.Builder`	`exclude(java.util.List<java.lang.String> exclude)` Glob patterns to exclude from the copy.
`DockerImageAsset.Builder`	`extraHash(java.lang.String extraHash)` Extra information to encode into the fingerprint (e.g.
`DockerImageAsset.Builder`	`file(java.lang.String file)` Path to the Dockerfile (relative to the directory).
`DockerImageAsset.Builder`	`follow(FollowMode follow)` Deprecated. use `followSymlinks` instead
`DockerImageAsset.Builder`	`followSymlinks(SymlinkFollowMode followSymlinks)` A strategy for how to handle symlinks.
`DockerImageAsset.Builder`	`ignoreMode(IgnoreMode ignoreMode)` The ignore behavior to use for exclude patterns.
`DockerImageAsset.Builder`	`invalidation(DockerImageAssetInvalidationOptions invalidation)` Options to control which parameters are used to invalidate the asset hash.
`DockerImageAsset.Builder`	`networkMode(NetworkMode networkMode)` Networking mode for the RUN commands during build.
`DockerImageAsset.Builder`	`platform(Platform platform)` Platform to build for.
`DockerImageAsset.Builder`	`repositoryName(java.lang.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(java.lang.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
```
public static DockerImageAsset.Builder create(software.constructs.Construct scope,
                                              java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of DockerImageAsset.Builder.
  - exclude
```
public DockerImageAsset.Builder exclude(java.util.List<java.lang.String> exclude)
```
    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
```
@Deprecated
public DockerImageAsset.Builder follow(FollowMode follow)
```
    Deprecated. use `followSymlinks` instead
    
    (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
```
public DockerImageAsset.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
```
public DockerImageAsset.Builder extraHash(java.lang.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
  - followSymlinks
```
public DockerImageAsset.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
  - buildArgs
```
public DockerImageAsset.Builder buildArgs(java.util.Map<java.lang.String,java.lang.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
```
public DockerImageAsset.Builder file(java.lang.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
```
public DockerImageAsset.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
```
public DockerImageAsset.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
```
public DockerImageAsset.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
  - repositoryName
```
@Deprecated
public DockerImageAsset.Builder repositoryName(java.lang.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
```
public DockerImageAsset.Builder target(java.lang.String target)
```
    Docker target to build to.
    Default: - no target
    
    Parameters:
    
    target - Docker target to build to. This parameter is required.
    
    Returns:
    
    this
  - directory
```
public DockerImageAsset.Builder directory(java.lang.String directory)
```
    The directory where the Dockerfile is stored.
    Any directory inside with a name that matches the CDK output folder (cdk.out by default) will be excluded from the asset
    
    Parameters:
    
    directory - The directory where the Dockerfile is stored. This parameter is required.
    
    Returns:
    
    this
  - build
```
public DockerImageAsset build()
```

Class DockerImageAsset.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

exclude

follow

ignoreMode

extraHash

followSymlinks

buildArgs

file

invalidation

networkMode

platform

repositoryName

target

directory

build