Package software.amazon.awscdk.services.ecr.assets

Interface DockerImageAssetOptions

All Superinterfaces:
CopyOptions, FileCopyOptions, FileFingerprintOptions, FingerprintOptions, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
AssetImageCodeProps, AssetImageProps, DockerImageAssetProps
All Known Implementing Classes:
AssetImageCodeProps.Jsii$Proxy, AssetImageProps.Jsii$Proxy, DockerImageAssetOptions.Jsii$Proxy, DockerImageAssetProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.985Z") @Stability(Stable) public interface DockerImageAssetOptions extends software.amazon.jsii.JsiiSerializable, FingerprintOptions, FileFingerprintOptions
Options for DockerImageAsset.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.assets.*;
 import software.amazon.awscdk.services.ecr.assets.*;
 import software.amazon.awscdk.core.*;
 NetworkMode networkMode;
 Platform platform;
 DockerImageAssetOptions dockerImageAssetOptions = DockerImageAssetOptions.builder()
         .buildArgs(Map.of(
                 "buildArgsKey", "buildArgs"))
         .exclude(List.of("exclude"))
         .extraHash("extraHash")
         .file("file")
         .follow(FollowMode.NEVER)
         .followSymlinks(SymlinkFollowMode.NEVER)
         .ignoreMode(IgnoreMode.GLOB)
         .invalidation(DockerImageAssetInvalidationOptions.builder()
                 .buildArgs(false)
                 .extraHash(false)
                 .file(false)
                 .networkMode(false)
                 .platform(false)
                 .repositoryName(false)
                 .target(false)
                 .build())
         .networkMode(networkMode)
         .platform(platform)
         .repositoryName("repositoryName")
         .target("target")
         .build();

  • Method Details

    • getBuildArgs

      @Stability(Stable) @Nullable default Map<String,String> getBuildArgs()
      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

    • getFile

      @Stability(Stable) @Nullable default String getFile()
      Path to the Dockerfile (relative to the directory).

      Default: 'Dockerfile'

    • getInvalidation

      @Stability(Stable) @Nullable default DockerImageAssetInvalidationOptions getInvalidation()
      Options to control which parameters are used to invalidate the asset hash.

      Default: - hash all parameters

    • getNetworkMode

      @Stability(Stable) @Nullable default NetworkMode getNetworkMode()
      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)

    • getPlatform

      @Stability(Stable) @Nullable default Platform getPlatform()
      Platform to build for.

      Requires Docker Buildx.

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

    • getRepositoryName

      @Stability(Deprecated) @Deprecated @Nullable default String getRepositoryName()
      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

    • getTarget

      @Stability(Stable) @Nullable default String getTarget()
      Docker target to build to.

      Default: - no target

    • getExtraHash

      @Stability(Deprecated) @Deprecated @Nullable default String getExtraHash()
      Deprecated.
      (deprecated) Extra information to encode into the fingerprint (e.g. build instructions and other inputs).

      Default: - hash is only based on source content

      Specified by:
      getExtraHash in interface FileFingerprintOptions
      Specified by:
      getExtraHash in interface FingerprintOptions

    • getExclude

      @Stability(Deprecated) @Deprecated @Nullable default List<String> getExclude()
      Deprecated.
      (deprecated) Glob patterns to exclude from the copy.

      Default: nothing is excluded

      Specified by:
      getExclude in interface CopyOptions
      Specified by:
      getExclude in interface FileCopyOptions

    • getIgnoreMode

      @Stability(Deprecated) @Deprecated @Nullable default IgnoreMode getIgnoreMode()
      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 '

      Specified by:
      getIgnoreMode in interface CopyOptions
      Specified by:
      getIgnoreMode in interface FileCopyOptions

    • builder

      @Stability(Stable) static DockerImageAssetOptions.Builder builder()
      Returns:
      a DockerImageAssetOptions.Builder of DockerImageAssetOptions