software.amazon.awscdk.services.ecr.assets

Interface DockerImageAssetOptions

All Superinterfaces:

FileCopyOptions, FileFingerprintOptions, 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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.546Z")
 @Stability(value=Stable)
public interface DockerImageAssetOptions
extends software.amazon.jsii.JsiiSerializable, 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.*;
 import software.amazon.awscdk.services.ecr.assets.*;
 NetworkMode networkMode;
 Platform platform;
 DockerImageAssetOptions dockerImageAssetOptions = DockerImageAssetOptions.builder()
         .buildArgs(Map.of(
                 "buildArgsKey", "buildArgs"))
         .exclude(List.of("exclude"))
         .extraHash("extraHash")
         .file("file")
         .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)
         .target("target")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DockerImageAssetOptions.Builder A builder for DockerImageAssetOptions
static class	DockerImageAssetOptions.Jsii$Proxy An implementation for DockerImageAssetOptions

Method Summary

Modifier and Type	Method and Description
static DockerImageAssetOptions.Builder	builder()
default Map<String,String>	getBuildArgs() Build args to pass to the `docker build` command.
default String	getFile() Path to the Dockerfile (relative to the directory).
default DockerImageAssetInvalidationOptions	getInvalidation() Options to control which parameters are used to invalidate the asset hash.
default NetworkMode	getNetworkMode() Networking mode for the RUN commands during build.
default Platform	getPlatform() Platform to build for.
default String	getTarget() Docker target to build to.

Methods inherited from interface software.amazon.awscdk.FileFingerprintOptions

getExtraHash

Methods inherited from interface software.amazon.awscdk.FileCopyOptions

getExclude, getFollowSymlinks, getIgnoreMode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBuildArgs

@Stability(value=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(value=Stable)
 @Nullable
default String getFile()

Path to the Dockerfile (relative to the directory).

Default: 'Dockerfile'

getInvalidation

@Stability(value=Stable)
 @Nullable
default DockerImageAssetInvalidationOptions getInvalidation()

Options to control which parameters are used to invalidate the asset hash.

Default: - hash all parameters

getNetworkMode

@Stability(value=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(value=Stable)
 @Nullable
default Platform getPlatform()

Platform to build for.

Requires Docker Buildx.

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

getTarget

@Stability(value=Stable)
 @Nullable
default String getTarget()

Docker target to build to.

Default: - no target

builder

@Stability(value=Stable)
static DockerImageAssetOptions.Builder builder()

Specified by:

builder in interface FileCopyOptions

Specified by:

builder in interface FileFingerprintOptions

Returns:

a DockerImageAssetOptions.Builder of DockerImageAssetOptions