CodeImageConfig — AWS Cloud Development Kit 1.204.0 documentation (original) (raw)
class aws_cdk.aws_lambda.CodeImageConfig(*, image_uri, cmd=None, entrypoint=None, working_directory=None)
Bases: object
Result of the bind when an ECR image is used.
Parameters:
- image_uri (
str) – URI to the Docker image. - cmd (
Optional[Sequence[str]]) – 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. - entrypoint (
Optional[Sequence[str]]) – 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. - working_directory (
Optional[str]) – 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.
ExampleMetadata:
fixture=_generated
Example:
The code below shows an example of how to instantiate this type.
The values are placeholders you should change.
import aws_cdk.aws_lambda as lambda_
code_image_config = lambda.CodeImageConfig( image_uri="imageUri",
# the properties below are optional
cmd=["cmd"],
entrypoint=["entrypoint"],
working_directory="workingDirectory")
Attributes
cmd
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:
https://docs.docker.com/engine/reference/builder/#cmd
entrypoint
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:
https://docs.docker.com/engine/reference/builder/#entrypoint
image_uri
URI to the Docker image.
working_directory
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: