interface DockerImageSource
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CloudAssembly.Schema.DockerImageSource |
 Java | software.amazon.awscdk.cloudassembly.schema.DockerImageSource |
 Python | aws_cdk.cloud_assembly_schema.DockerImageSource |
 TypeScript | @aws-cdk/cloud-assembly-schema » DockerImageSource |
Properties for how to produce a Docker image from a source.
Properties
| Name | Type | Description |
|---|---|---|
| cache | boolean | Disable the cache and pass --no-cache to the docker build command. |
| cache | Docker[] | Cache from options to pass to the docker build command. |
| cache | Docker | Cache to options to pass to the docker build command. |
| directory? | string | The directory containing the Docker image build instructions. |
| docker | { [string]: string } | Additional build arguments. |
| docker | { [string]: string } | Additional build secrets. |
| docker | string | SSH agent socket or keys. |
| docker | string | Target build stage in a Dockerfile with multiple build stages. |
| docker | string | The name of the file with build instructions. |
| docker | string[] | Outputs. |
| executable? | string[] | A command-line executable that returns the name of a local Docker image on stdout after being run. |
| network | string | Networking mode for the RUN commands during build. Requires Docker Engine API v1.25+. |
| platform? | string | Platform to build for. Requires Docker Buildx. |
cacheDisabled?
Type:
boolean
(optional, default: cache is used)
Disable the cache and pass --no-cache to the docker build command.
cacheFrom?
Type:
Docker[]
(optional, default: no cache from options are passed to the build command)
Cache from options to pass to the docker build command.
See also: https://docs.docker.com/build/cache/backends/
cacheTo?
Type:
Docker
(optional, default: no cache to options are passed to the build command)
Cache to options to pass to the docker build command.
See also: https://docs.docker.com/build/cache/backends/
directory?
Type:
string
(optional, default: Exactly one of directory and executable is required)
The directory containing the Docker image build instructions.
This path is relative to the asset manifest location.
dockerBuildArgs?
Type:
{ [string]: string }
(optional, default: No additional build arguments)
Additional build arguments.
Only allowed when directory is set.
dockerBuildSecrets?
Type:
{ [string]: string }
(optional, default: No additional build secrets)
Additional build secrets.
Only allowed when directory is set.
dockerBuildSsh?
Type:
string
(optional, default: No ssh flag is set)
SSH agent socket or keys.
Requires building with docker buildkit.
dockerBuildTarget?
Type:
string
(optional, default: The last stage in the Dockerfile)
Target build stage in a Dockerfile with multiple build stages.
Only allowed when directory is set.
dockerFile?
Type:
string
(optional, default: "Dockerfile")
The name of the file with build instructions.
Only allowed when directory is set.
dockerOutputs?
Type:
string[]
(optional, default: no outputs are passed to the build command (default outputs are used))
Outputs.
See also: https://docs.docker.com/engine/reference/commandline/build/#custom-build-outputs
executable?
Type:
string[]
(optional, default: Exactly one of directory and executable is required)
A command-line executable that returns the name of a local Docker image on stdout after being run.
networkMode?
Type:
string
(optional, default: no networking mode specified)
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.
platform?
Type:
string
(optional, default: current machine platform)
Platform to build for. Requires Docker Buildx.
Specify this property to build images on a specific platform/architecture.