Package software.amazon.awscdk.services.lambda

Interface AssetImageCodeProps

All Superinterfaces:

DockerImageAssetOptions, FileCopyOptions, FileFingerprintOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AssetImageCodeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-18T22:16:58.472Z")
@Stability(Stable)
public interface AssetImageCodeProps
extends software.amazon.jsii.JsiiSerializable, DockerImageAssetOptions

Properties to initialize a new AssetImage.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ecr.assets.*;
 import software.amazon.awscdk.services.lambda.*;
 NetworkMode networkMode;
 Platform platform;
 AssetImageCodeProps assetImageCodeProps = AssetImageCodeProps.builder()
         .assetName("assetName")
         .buildArgs(Map.of(
                 "buildArgsKey", "buildArgs"))
         .buildSecrets(Map.of(
                 "buildSecretsKey", "buildSecrets"))
         .buildSsh("buildSsh")
         .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())
         .cmd(List.of("cmd"))
         .entrypoint(List.of("entrypoint"))
         .exclude(List.of("exclude"))
         .extraHash("extraHash")
         .file("file")
         .followSymlinks(SymlinkFollowMode.NEVER)
         .ignoreMode(IgnoreMode.GLOB)
         .invalidation(DockerImageAssetInvalidationOptions.builder()
                 .buildArgs(false)
                 .buildSecrets(false)
                 .buildSsh(false)
                 .extraHash(false)
                 .file(false)
                 .networkMode(false)
                 .outputs(false)
                 .platform(false)
                 .repositoryName(false)
                 .target(false)
                 .build())
         .networkMode(networkMode)
         .outputs(List.of("outputs"))
         .platform(platform)
         .target("target")
         .workingDirectory("workingDirectory")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AssetImageCodeProps.Builder	builder()
default List<String>	getCmd()	Specify or override the CMD on the specified Docker image or Dockerfile.
default List<String>	getEntrypoint()	Specify or override the ENTRYPOINT on the specified Docker image or Dockerfile.
default String	getWorkingDirectory()	Specify or override the WORKDIR on the specified Docker image or Dockerfile.

Methods inherited from interface software.amazon.awscdk.services.ecr.assets.DockerImageAssetOptions

getAssetName, getBuildArgs, getBuildSecrets, getBuildSsh, getCacheDisabled, getCacheFrom, getCacheTo, getFile, getInvalidation, getNetworkMode, getOutputs, getPlatform, getTarget

Methods inherited from interface software.amazon.awscdk.FileCopyOptions

getExclude, getFollowSymlinks, getIgnoreMode

Methods inherited from interface software.amazon.awscdk.FileFingerprintOptions

getExtraHash

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCmd

@Stability(Stable)
@Nullable
default List<String> getCmd()

Specify or override the CMD on the specified Docker image or Dockerfile.

This needs to be in the 'exec form', viz., [ 'executable', 'param1', 'param2' ].

Default: - use the CMD specified in the docker image or Dockerfile.

See Also:

• https://docs.docker.com/engine/reference/builder/#cmd

getEntrypoint

@Stability(Stable)
@Nullable
default List<String> getEntrypoint()

Specify or override the ENTRYPOINT on the specified Docker image or Dockerfile.

An ENTRYPOINT allows you to configure a container that will run as an executable. This needs to be in the 'exec form', viz., [ 'executable', 'param1', 'param2' ].

Default: - use the ENTRYPOINT in the docker image or Dockerfile.

See Also:

• https://docs.docker.com/engine/reference/builder/#entrypoint

getWorkingDirectory

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

Specify or override the WORKDIR on the specified Docker image or Dockerfile.

A WORKDIR allows you to configure the working directory the container will use.

Default: - use the WORKDIR in the docker image or Dockerfile.

See Also:

• https://docs.docker.com/engine/reference/builder/#workdir

builder

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

Returns:

a AssetImageCodeProps.Builder of AssetImageCodeProps