software.amazon.awscdk.core

Interface DockerImageAssetSource

All Known Implementing Classes:

DockerImageAssetSource.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:53.055Z")
public interface DockerImageAssetSource

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")
         .repositoryName("repositoryName")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getSourceHash

java.lang.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

default java.lang.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

default java.util.Map<java.lang.String,java.lang.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

default java.lang.String getDockerBuildTarget()

Docker target to build to.

Only allowed when directoryName is specified.

Default: - no target

getDockerFile

default java.lang.String getDockerFile()

Path to the Dockerfile (relative to the directory).

Only allowed when directoryName is specified.

Default: - no file

getExecutable

default java.util.List<java.lang.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

default java.lang.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

getRepositoryName

@Deprecated
default java.lang.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

static DockerImageAssetSource.Builder builder()

Returns:

a DockerImageAssetSource.Builder of DockerImageAssetSource