AssetImageCodeProps

class aws_cdk.aws_lambda.AssetImageCodeProps(*, exclude=None, follow=None, ignore_mode=None, extra_hash=None, follow_symlinks=None, build_args=None, file=None, invalidation=None, network_mode=None, platform=None, repository_name=None, target=None, cmd=None, entrypoint=None, working_directory=None)

Bases: DockerImageAssetOptions

Properties to initialize a new AssetImage.

Parameters:

exclude (Optional[Sequence[str]]) – Glob patterns to exclude from the copy. Default: - nothing is excluded
follow (Optional[FollowMode]) – (deprecated) A strategy for how to handle symlinks. Default: Never
ignore_mode (Optional[IgnoreMode]) – The ignore behavior to use for exclude patterns. Default: IgnoreMode.GLOB
extra_hash (Optional[str]) – Extra information to encode into the fingerprint (e.g. build instructions and other inputs). Default: - hash is only based on source content
follow_symlinks (Optional[SymlinkFollowMode]) – A strategy for how to handle symlinks. Default: SymlinkFollowMode.NEVER
build_args (Optional[Mapping[str, str]]) – Build args to pass to the docker build command. Since Docker build arguments are resolved before deployment, keys and values cannot refer to unresolved tokens (such as lambda.functionArn or queue.queueUrl). Default: - no build args are passed
file (Optional[str]) – Path to the Dockerfile (relative to the directory). Default: ‘Dockerfile’
invalidation (Union[DockerImageAssetInvalidationOptions, Dict[str, Any], None]) – Options to control which parameters are used to invalidate the asset hash. Default: - hash all parameters
network_mode (Optional[NetworkMode]) – Networking mode for the RUN commands during build. Support docker API 1.25+. Default: - no networking mode specified (the default networking mode NetworkMode.DEFAULT will be used)
platform (Optional[Platform]) – Platform to build for. Requires Docker Buildx. Default: - no platform specified (the current machine architecture will be used)
repository_name (Optional[str]) – (deprecated) ECR repository name. Specify this property if you need to statically address the image, e.g. from a Kubernetes Pod. Note, this is only the repository name, without the registry and the tag parts. Default: - the default ECR repository for CDK assets
target (Optional[str]) – Docker target to build to. Default: - no target
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.assets as assets
import aws_cdk.aws_ecr_assets as ecr_assets
import aws_cdk.aws_lambda as lambda_
import aws_cdk.core as cdk

# network_mode: ecr_assets.NetworkMode
# platform: ecr_assets.Platform

asset_image_code_props = lambda.AssetImageCodeProps(
    build_args={
        "build_args_key": "buildArgs"
    },
    cmd=["cmd"],
    entrypoint=["entrypoint"],
    exclude=["exclude"],
    extra_hash="extraHash",
    file="file",
    follow=assets.FollowMode.NEVER,
    follow_symlinks=cdk.SymlinkFollowMode.NEVER,
    ignore_mode=cdk.IgnoreMode.GLOB,
    invalidation=ecr_assets.DockerImageAssetInvalidationOptions(
        build_args=False,
        extra_hash=False,
        file=False,
        network_mode=False,
        platform=False,
        repository_name=False,
        target=False
    ),
    network_mode=network_mode,
    platform=platform,
    repository_name="repositoryName",
    target="target",
    working_directory="workingDirectory"
)

Attributes

build_args

Build args to pass to the docker build command.

Since Docker build arguments are resolved before deployment, keys and values cannot refer to unresolved tokens (such as lambda.functionArn or queue.queueUrl).

Default:

no build args are passed

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

exclude

Glob patterns to exclude from the copy.

Default:

nothing is excluded

extra_hash

Extra information to encode into the fingerprint (e.g. build instructions and other inputs).

Default:

hash is only based on source content

file

Path to the Dockerfile (relative to the directory).

Default:: ‘Dockerfile’

follow

(deprecated) A strategy for how to handle symlinks.

Default:: Never
Deprecated:: use followSymlinks instead
Stability:: deprecated

follow_symlinks

A strategy for how to handle symlinks.

Default:: SymlinkFollowMode.NEVER

ignore_mode

The ignore behavior to use for exclude patterns.

Default:: IgnoreMode.GLOB

invalidation

Options to control which parameters are used to invalidate the asset hash.

Default:

hash all parameters

network_mode

Networking mode for the RUN commands during build.

Support docker API 1.25+.

Default:

no networking mode specified (the default networking mode NetworkMode.DEFAULT will be used)

platform

Platform to build for.

Requires Docker Buildx.

Default:

no platform specified (the current machine architecture will be used)

repository_name

(deprecated) ECR repository name.

Specify this property if you need to statically address the image, e.g. from a Kubernetes Pod. Note, this is only the repository name, without the registry and the tag parts.

Default:

the default ECR repository for CDK assets

Deprecated:

to control the location of docker image assets, please override Stack.addDockerImageAsset. this feature will be removed in future releases.

Stability:: deprecated

target

Docker target to build to.

Default:

no target

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:

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