Package software.amazon.awscdk.services.lambda

Interface CodeImageConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CodeImageConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-31T18:44:12.328Z")
@Stability(Stable)
public interface CodeImageConfig
extends software.amazon.jsii.JsiiSerializable

Result of the bind when an ECR image is used.

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.*;
 CodeImageConfig codeImageConfig = CodeImageConfig.builder()
         .imageUri("imageUri")
         // the properties below are optional
         .cmd(List.of("cmd"))
         .entrypoint(List.of("entrypoint"))
         .workingDirectory("workingDirectory")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CodeImageConfig.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.
String	getImageUri()	URI to the Docker image.
default String	getWorkingDirectory()	Specify or override the WORKDIR on the specified Docker image or Dockerfile.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImageUri

@Stability(Stable)
@NotNull
String getImageUri()

URI to the Docker image.

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 CodeImageConfig.Builder builder()

Returns:

a CodeImageConfig.Builder of CodeImageConfig