Package software.amazon.awscdk.services.lambda

Interface DockerBuildAssetOptions

All Superinterfaces:

DockerBuildOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DockerBuildAssetOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-26T00:07:40.418Z")
@Stability(Stable)
public interface DockerBuildAssetOptions
extends software.amazon.jsii.JsiiSerializable, DockerBuildOptions

Options when creating an asset from a Docker build.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 DockerBuildAssetOptions dockerBuildAssetOptions = DockerBuildAssetOptions.builder()
         .buildArgs(Map.of(
                 "buildArgsKey", "buildArgs"))
         .cacheDisabled(false)
         .cacheFrom(List.of(DockerCacheOption.builder()
                 .type("type")
                 // the properties below are optional
                 .params(Map.of(
                         "paramsKey", "params"))
                 .build()))
         .cacheTo(DockerCacheOption.builder()
                 .type("type")
                 // the properties below are optional
                 .params(Map.of(
                         "paramsKey", "params"))
                 .build())
         .file("file")
         .imagePath("imagePath")
         .outputPath("outputPath")
         .platform("platform")
         .targetStage("targetStage")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DockerBuildAssetOptions.Builder	builder()
default String	getImagePath()	The path in the Docker image where the asset is located after the build operation.
default String	getOutputPath()	The path on the local filesystem where the asset will be copied using docker cp.

Methods inherited from interface software.amazon.awscdk.DockerBuildOptions

getBuildArgs, getCacheDisabled, getCacheFrom, getCacheTo, getFile, getPlatform, getTargetStage

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImagePath

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

The path in the Docker image where the asset is located after the build operation.

Default: /asset

getOutputPath

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

The path on the local filesystem where the asset will be copied using docker cp.

Default: - a unique temporary directory in the system temp directory

builder

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

Returns:

a DockerBuildAssetOptions.Builder of DockerBuildAssetOptions