software.amazon.awscdk.services.ecr.assets

Interface DockerImageAssetOptions

All Superinterfaces:

CopyOptions, 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.26.0 (build 7d76e02)",
           date="2021-03-25T11:29:46.040Z")
 @Stability(value=Experimental)
public interface DockerImageAssetOptions
extends software.amazon.jsii.JsiiSerializable, FingerprintOptions

(experimental) Options for DockerImageAsset.

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() (experimental) Build args to pass to the `docker build` command.
default String	getFile() (experimental) Path to the Dockerfile (relative to the directory).
default String	getRepositoryName() Deprecated. to control the location of docker image assets, please override `Stack.addDockerImageAsset`. this feature will be removed in future releases.
default String	getTarget() (experimental) Docker target to build to.

Methods inherited from interface software.amazon.awscdk.assets.FingerprintOptions

getExtraHash

Methods inherited from interface software.amazon.awscdk.assets.CopyOptions

getExclude, getFollow, getIgnoreMode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBuildArgs

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getBuildArgs()

(experimental) 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=Experimental)
 @Nullable
default String getFile()

(experimental) Path to the Dockerfile (relative to the directory).

Default: 'Dockerfile'

getRepositoryName

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

(experimental) Docker target to build to.

Default: - no target

builder

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

Specified by:

builder in interface CopyOptions

Specified by:

builder in interface FingerprintOptions

Returns:

a DockerImageAssetOptions.Builder of DockerImageAssetOptions