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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.888Z")
 @Stability(value=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 and Description
static class	DockerBuildOptions.Builder A builder for DockerBuildOptions
static class	DockerBuildOptions.Jsii$Proxy An implementation for DockerBuildOptions

Method Summary

Modifier and Type	Method and Description
static DockerBuildOptions.Builder	builder()
default Map<String,String>	getBuildArgs() Build args.
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 Detail

getBuildArgs

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

Build args.

Default: - no build args

getFile

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

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

Default: `Dockerfile`

getPlatform

@Stability(value=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(value=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(value=Stable)
static DockerBuildOptions.Builder builder()

Returns:

a DockerBuildOptions.Builder of DockerBuildOptions