Package software.amazon.awscdk.services.lambda

Interface EcrImageCodeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EcrImageCodeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:40.706Z")
@Stability(Stable)
public interface EcrImageCodeProps
extends software.amazon.jsii.JsiiSerializable

Properties to initialize a new EcrImageCode.

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.*;
 EcrImageCodeProps ecrImageCodeProps = EcrImageCodeProps.builder()
         .cmd(List.of("cmd"))
         .entrypoint(List.of("entrypoint"))
         .tag("tag")
         .tagOrDigest("tagOrDigest")
         .workingDirectory("workingDirectory")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EcrImageCodeProps.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	getTag()	Deprecated. use tagOrDigest
default String	getTagOrDigest()	The image tag or digest to use when pulling the image from ECR (digests must start with sha256:).
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

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

getTag

@Stability(Deprecated)
@Deprecated
@Nullable
default String getTag()

Deprecated.

use tagOrDigest

(deprecated) The image tag to use when pulling the image from ECR.

Default: 'latest'

getTagOrDigest

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

The image tag or digest to use when pulling the image from ECR (digests must start with sha256:).

Default: 'latest'

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

Returns:

a EcrImageCodeProps.Builder of EcrImageCodeProps