Skip to content
v2.274.0

CodeImageConfig Struct ​

Result of the bind when an ECR image is used.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const codeImageConfig: lambda.CodeImageConfig = {
  imageUri: 'imageUri',

  // the properties below are optional
  cmd: ['cmd'],
  entrypoint: ['entrypoint'],
  workingDirectory: 'workingDirectory',
};

Properties ​

cmdstring[]cmdtyping.List[str]cmdList<String>Cmdstring[]Cmd*[]*string= use the CMD specified in the doc…#
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

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

entrypointstring[]entrypointtyping.List[str]entrypointList<String>Entrypointstring[]Entrypoint*[]*string= use the ENTRYPOINT in the docker…#
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

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

imageUristringimage_uristrimageUriStringImageUristringImageUri*stringrequired#
URI to the Docker image.
workingDirectorystringworking_directorystrworkingDirectoryStringWorkingDirectorystringWorkingDirectory*string= use the WORKDIR in the docker im…#
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

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