EcrImageCodeProps¶
-
class
aws_cdk.aws_lambda.
EcrImageCodeProps
(*, cmd=None, entrypoint=None, tag=None, tag_or_digest=None, working_directory=None)¶ Bases:
object
Properties to initialize a new EcrImageCode.
- Parameters
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.tag (
Optional
[str
]) – (deprecated) The image tag to use when pulling the image from ECR. Default: ‘latest’tag_or_digest (
Optional
[str
]) – The image tag or digest to use when pulling the image from ECR (digests must start withsha256:
). Default: ‘latest’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_ ecr_image_code_props = lambda.EcrImageCodeProps( cmd=["cmd"], entrypoint=["entrypoint"], tag="tag", tag_or_digest="tagOrDigest", 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
- Return type
Optional
[List
[str
]]
-
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
- Return type
Optional
[List
[str
]]
-
tag
¶ (deprecated) The image tag to use when pulling the image from ECR.
- Default
‘latest’
- Deprecated
use
tagOrDigest
- Stability
deprecated
- Return type
Optional
[str
]
-
tag_or_digest
¶ The image tag or digest to use when pulling the image from ECR (digests must start with
sha256:
).- Default
‘latest’
- Return type
Optional
[str
]
-
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
- Return type
Optional
[str
]