interface AssetImageCodeProps

Language	Type name
.NET	`Amazon.CDK.AWS.Lambda.AssetImageCodeProps`
Java	`software.amazon.awscdk.services.lambda.AssetImageCodeProps`
Python	`aws_cdk.aws_lambda.AssetImageCodeProps`
TypeScript (source)	`@aws-cdk/aws-lambda` » `AssetImageCodeProps`

Properties to initialize a new AssetImage.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as assets from '@aws-cdk/assets';
import * as ecr_assets from '@aws-cdk/aws-ecr-assets';
import * as lambda from '@aws-cdk/aws-lambda';
import * as cdk from '@aws-cdk/core';

declare const networkMode: ecr_assets.NetworkMode;
declare const platform: ecr_assets.Platform;
const assetImageCodeProps: lambda.AssetImageCodeProps = {
  buildArgs: {
    buildArgsKey: 'buildArgs',
  },
  cmd: ['cmd'],
  entrypoint: ['entrypoint'],
  exclude: ['exclude'],
  extraHash: 'extraHash',
  file: 'file',
  follow: assets.FollowMode.NEVER,
  followSymlinks: cdk.SymlinkFollowMode.NEVER,
  ignoreMode: cdk.IgnoreMode.GLOB,
  invalidation: {
    buildArgs: false,
    extraHash: false,
    file: false,
    networkMode: false,
    platform: false,
    repositoryName: false,
    target: false,
  },
  networkMode: networkMode,
  platform: platform,
  repositoryName: 'repositoryName',
  target: 'target',
  workingDirectory: 'workingDirectory',
};

Properties

Name	Type	Description
buildArgs?	`{ [string]: string }`	Build args to pass to the `docker build` command.
cmd?	`string[]`	Specify or override the CMD on the specified Docker image or Dockerfile.
entrypoint?	`string[]`	Specify or override the ENTRYPOINT on the specified Docker image or Dockerfile.
exclude?	`string[]`	Glob patterns to exclude from the copy.
extraHash?	`string`	Extra information to encode into the fingerprint (e.g. build instructions and other inputs).
file?	`string`	Path to the Dockerfile (relative to the directory).
follow?⚠️	`FollowMode`	A strategy for how to handle symlinks.
followSymlinks?	`SymlinkFollowMode`	A strategy for how to handle symlinks.
ignoreMode?	`IgnoreMode`	The ignore behavior to use for exclude patterns.
invalidation?	`DockerImageAssetInvalidationOptions`	Options to control which parameters are used to invalidate the asset hash.
networkMode?	`NetworkMode`	Networking mode for the RUN commands during build.
platform?	`Platform`	Platform to build for.
repositoryName?⚠️	`string`	ECR repository name.
target?	`string`	Docker target to build to.
workingDirectory?	`string`	Specify or override the WORKDIR on the specified Docker image or Dockerfile.

buildArgs?

Type: { [string]: string } (optional, default: no build args are passed)

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).

cmd?

Type: string[] (optional, default: use the CMD specified in the docker image or Dockerfile.)

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

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

entrypoint?

Type: string[] (optional, default: use the ENTRYPOINT in the docker image or Dockerfile.)

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' ].

exclude?

Type: string[] (optional, default: nothing is excluded)

Glob patterns to exclude from the copy.

extraHash?

Type: string (optional, default: hash is only based on source content)

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

file?

Type: string (optional, default: 'Dockerfile')

Path to the Dockerfile (relative to the directory).

follow?⚠️

⚠️ Deprecated: use followSymlinks instead

Type: FollowMode (optional, default: Never)

A strategy for how to handle symlinks.

followSymlinks?

Type: SymlinkFollowMode (optional, default: SymlinkFollowMode.NEVER)

A strategy for how to handle symlinks.

ignoreMode?

Type: IgnoreMode (optional, default: IgnoreMode.GLOB)

The ignore behavior to use for exclude patterns.

invalidation?

Type: DockerImageAssetInvalidationOptions (optional, default: hash all parameters)

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

networkMode?

Type: NetworkMode (optional, default: no networking mode specified (the default networking mode NetworkMode.DEFAULT will be used))

Networking mode for the RUN commands during build.

Support docker API 1.25+.

platform?

Type: Platform (optional, default: no platform specified (the current machine architecture will be used))

Platform to build for.

Requires Docker Buildx.

repositoryName?⚠️

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

Type: string (optional, default: the default ECR repository for CDK assets)

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.

target?

Type: string (optional, default: no target)

Docker target to build to.

workingDirectory?

Type: string (optional, default: use the WORKDIR in the docker image or Dockerfile.)

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.