Class CodeImageConfig

Result of the bind when an ECR image is used.

Inheritance

System.Object

CodeImageConfig

Implements

ICodeImageConfig

Namespace: Amazon.CDK.AWS.Lambda

Assembly: Amazon.CDK.AWS.Lambda.dll

Syntax (csharp)

public class CodeImageConfig : Object, ICodeImageConfig

Syntax (vb)

Public Class CodeImageConfig
    Inherits Object
    Implements ICodeImageConfig

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lambda;

var codeImageConfig = new CodeImageConfig {
    ImageUri = "imageUri",

    // the properties below are optional
    Cmd = new [] { "cmd" },
    Entrypoint = new [] { "entrypoint" },
    WorkingDirectory = "workingDirectory"
};

Synopsis

Constructors

CodeImageConfig()

Properties

Cmd	Specify or override the CMD on the specified Docker image or Dockerfile.
Entrypoint	Specify or override the ENTRYPOINT on the specified Docker image or Dockerfile.
ImageUri	URI to the Docker image.
WorkingDirectory	Specify or override the WORKDIR on the specified Docker image or Dockerfile.

Constructors

CodeImageConfig()

public CodeImageConfig()

Properties

Cmd

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

public string[] Cmd { get; set; }

Property Value

System.String[]

Remarks

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

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

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

Entrypoint

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

public string[] Entrypoint { get; set; }

Property Value

System.String[]

Remarks

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: https://docs.docker.com/engine/reference/builder/#entrypoint

ImageUri

URI to the Docker image.

public string ImageUri { get; set; }

Property Value

System.String

WorkingDirectory

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

public string WorkingDirectory { get; set; }

Property Value

System.String

Remarks

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

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

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

Implements

ICodeImageConfig