Package software.amazon.awscdk.core

Interface DockerImageAssetSource

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DockerImageAssetSource.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:55.026Z")
@Stability(Stable)
public interface DockerImageAssetSource
extends software.amazon.jsii.JsiiSerializable

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 DockerImageAssetSource dockerImageAssetSource = DockerImageAssetSource.builder()
         .sourceHash("sourceHash")
         // the properties below are optional
         .directoryName("directoryName")
         .dockerBuildArgs(Map.of(
                 "dockerBuildArgsKey", "dockerBuildArgs"))
         .dockerBuildTarget("dockerBuildTarget")
         .dockerFile("dockerFile")
         .executable(List.of("executable"))
         .networkMode("networkMode")
         .platform("platform")
         .repositoryName("repositoryName")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DockerImageAssetSource.Builder	builder()
default String	getDirectoryName()	The directory where the Dockerfile is stored, must be relative to the cloud assembly root.
default Map<String,String>	getDockerBuildArgs()	Build args to pass to the docker build command.
default String	getDockerBuildTarget()	Docker target to build to.
default String	getDockerFile()	Path to the Dockerfile (relative to the directory).
default List<String>	getExecutable()	An external command that will produce the packaged asset.
default String	getNetworkMode()	Networking mode for the RUN commands during build.
default String	getPlatform()	Platform to build for.
default String	getRepositoryName()	Deprecated. repository name should be specified at the environment-level and not at the image level
String	getSourceHash()	The hash of the contents of the docker build context.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSourceHash

@Stability(Stable)
@NotNull
String getSourceHash()

The hash of the contents of the docker build context.

This hash is used throughout the system to identify this image and avoid duplicate work in case the source did not change.

NOTE: this means that if you wish to update your docker image, you must make a modification to the source (e.g. add some metadata to your Dockerfile).

getDirectoryName

@Stability(Stable)
@Nullable
default String getDirectoryName()

The directory where the Dockerfile is stored, must be relative to the cloud assembly root.

Default: - Exactly one of `directoryName` and `executable` is required

getDockerBuildArgs

@Stability(Stable)
@Nullable
default Map<String,String> getDockerBuildArgs()

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).

Only allowed when directoryName is specified.

Default: - no build args are passed

getDockerBuildTarget

@Stability(Stable)
@Nullable
default String getDockerBuildTarget()

Docker target to build to.

Only allowed when directoryName is specified.

Default: - no target

getDockerFile

@Stability(Stable)
@Nullable
default String getDockerFile()

Path to the Dockerfile (relative to the directory).

Only allowed when directoryName is specified.

Default: - no file

getExecutable

@Stability(Stable)
@Nullable
default List<String> getExecutable()

An external command that will produce the packaged asset.

The command should produce the name of a local Docker image on stdout.

Default: - Exactly one of `directoryName` and `executable` is required

getNetworkMode

@Stability(Stable)
@Nullable
default String getNetworkMode()

Networking mode for the RUN commands during build. Requires Docker Engine API v1.25+.

Specify this property to build images on a specific networking mode.

Default: - no networking mode specified

getPlatform

@Stability(Stable)
@Nullable
default String getPlatform()

Platform to build for. Requires Docker Buildx.

Specify this property to build images on a specific platform.

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

getRepositoryName

@Stability(Deprecated)
@Deprecated
@Nullable
default String getRepositoryName()

Deprecated.

repository name should be specified at the environment-level and not at the image level

(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: - automatically derived from the asset's ID.

builder

@Stability(Stable)
static DockerImageAssetSource.Builder builder()

Returns:

a DockerImageAssetSource.Builder of DockerImageAssetSource