Package software.amazon.awscdk

Interface DockerBuildOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DockerBuildAssetOptions

All Known Implementing Classes:

DockerBuildAssetOptions.Jsii$Proxy, DockerBuildOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-11T23:26:27.520Z")
@Stability(Stable)
public interface DockerBuildOptions
extends software.amazon.jsii.JsiiSerializable

Docker build options.

Example:

 Function.Builder.create(this, "Function")
         .code(Code.fromAsset("/path/to/handler", AssetOptions.builder()
                 .bundling(BundlingOptions.builder()
                         .image(DockerImage.fromBuild("/path/to/dir/with/DockerFile", DockerBuildOptions.builder()
                                 .buildArgs(Map.of(
                                         "ARG1", "value1"))
                                 .build()))
                         .command(List.of("my", "cool", "command"))
                         .build())
                 .build()))
         .runtime(Runtime.PYTHON_3_9)
         .handler("index.handler")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DockerBuildOptions.Builder	builder()
default Map<String,String>	getBuildArgs()	Build args.
default Boolean	getCacheDisabled()	Disable the cache and pass --no-cache to the docker build command.
default List<DockerCacheOption>	getCacheFrom()	Cache from options to pass to the docker build command.
default DockerCacheOption	getCacheTo()	Cache to options to pass to the docker build command.
default String	getFile()	Name of the Dockerfile, must relative to the docker build path.
default String	getPlatform()	Set platform if server is multi-platform capable.
default String	getTargetStage()	Set build target for multi-stage container builds.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBuildArgs

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

Build args.

Default: - no build args

getCacheDisabled

@Stability(Stable)
@Nullable
default Boolean getCacheDisabled()

Disable the cache and pass --no-cache to the docker build command.

Default: - cache is used

getCacheFrom

@Stability(Stable)
@Nullable
default List<DockerCacheOption> getCacheFrom()

Cache from options to pass to the docker build command.

Default: - no cache from args are passed

getCacheTo

@Stability(Stable)
@Nullable
default DockerCacheOption getCacheTo()

Cache to options to pass to the docker build command.

Default: - no cache to args are passed

getFile

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

Name of the Dockerfile, must relative to the docker build path.

Default: `Dockerfile`

getPlatform

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

Set platform if server is multi-platform capable. Requires Docker Engine API v1.38+.

Example value: linux/amd64

Default: - no platform specified

getTargetStage

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

Set build target for multi-stage container builds. Any stage defined afterwards will be ignored.

Example value: build-env

Default: - Build all stages defined in the Dockerfile

builder

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

Returns:

a DockerBuildOptions.Builder of DockerBuildOptions