interface AssetImageProps

Language	Type name
.NET	`Amazon.CDK.AWS.ECS.AssetImageProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsecs#AssetImageProps`
Java	`software.amazon.awscdk.services.ecs.AssetImageProps`
Python	`aws_cdk.aws_ecs.AssetImageProps`
TypeScript (source)	`aws-cdk-lib` » `aws_ecs` » `AssetImageProps`

The properties for building an AssetImage.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ecr_assets as ecr_assets } from 'aws-cdk-lib';
import { aws_ecs as ecs } from 'aws-cdk-lib';

declare const networkMode: ecr_assets.NetworkMode;
declare const platform: ecr_assets.Platform;
const assetImageProps: ecs.AssetImageProps = {
  assetName: 'assetName',
  buildArgs: {
    buildArgsKey: 'buildArgs',
  },
  buildSecrets: {
    buildSecretsKey: 'buildSecrets',
  },
  buildSsh: 'buildSsh',
  cacheDisabled: false,
  cacheFrom: [{
    type: 'type',

    // the properties below are optional
    params: {
      paramsKey: 'params',
    },
  }],
  cacheTo: {
    type: 'type',

    // the properties below are optional
    params: {
      paramsKey: 'params',
    },
  },
  exclude: ['exclude'],
  extraHash: 'extraHash',
  file: 'file',
  followSymlinks: cdk.SymlinkFollowMode.NEVER,
  ignoreMode: cdk.IgnoreMode.GLOB,
  invalidation: {
    buildArgs: false,
    buildSecrets: false,
    buildSsh: false,
    extraHash: false,
    file: false,
    networkMode: false,
    outputs: false,
    platform: false,
    repositoryName: false,
    target: false,
  },
  networkMode: networkMode,
  outputs: ['outputs'],
  platform: platform,
  target: 'target',
};

Properties

Name	Type	Description
assetName?	`string`	Unique identifier of the docker image asset and its potential revisions.
buildArgs?	`{ [string]: string }`	Build args to pass to the `docker build` command.
buildSecrets?	`{ [string]: string }`	Build secrets.
buildSsh?	`string`	SSH agent socket or keys to pass to the `docker build` command.
cacheDisabled?	`boolean`	Disable the cache and pass `--no-cache` to the `docker build` command.
cacheFrom?	`DockerCacheOption[]`	Cache from options to pass to the `docker build` command.
cacheTo?	`DockerCacheOption`	Cache to options to pass to the `docker build` command.
exclude?	`string[]`	File paths matching the patterns will be excluded.
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).
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.
outputs?	`string[]`	Outputs to pass to the `docker build` command.
platform?	`Platform`	Platform to build for.
target?	`string`	Docker target to build to.

assetName?

Type: string (optional, default: no asset name)

Unique identifier of the docker image asset and its potential revisions.

Required if using AppScopedStagingSynthesizer.

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

buildSecrets?

Type: { [string]: string } (optional, default: no build secrets)

Build secrets.

Docker BuildKit must be enabled to use build secrets.

See also: https://docs.docker.com/build/buildkit/ Example

import { DockerBuildSecret } from 'aws-cdk-lib';

const buildSecrets = {
  'MY_SECRET': DockerBuildSecret.fromSrc('file.txt')
};

buildSsh?

Type: string (optional, default: no --ssh flag)

SSH agent socket or keys to pass to the docker build command.

Docker BuildKit must be enabled to use the ssh flag

cacheDisabled?

Type: boolean (optional, default: cache is used)

Disable the cache and pass --no-cache to the docker build command.

cacheFrom?

Type: DockerCacheOption[] (optional, default: no cache from options are passed to the build command)

Cache from options to pass to the docker build command.

cacheTo?

Type: DockerCacheOption (optional, default: no cache to options are passed to the build command)

Cache to options to pass to the docker build command.

exclude?

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

File paths matching the patterns will be excluded.

See ignoreMode to set the matching behavior. Has no effect on Assets bundled using the bundling property.

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

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

outputs?

Type: string[] (optional, default: no outputs are passed to the build command (default outputs are used))

Outputs to pass to the docker build command.

platform?

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

Platform to build for.

Requires Docker Buildx.

target?

Type: string (optional, default: no target)

Docker target to build to.