aws-cdk-lib.DockerCacheOption

DockerCacheOption Struct

Options for configuring the Docker cache backend.

Source

core/lib/assets.ts

Type last changed

v2.69.0 · 14 Mar 2023

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';
const dockerCacheOption: cdk.DockerCacheOption = {
  type: 'type',

  // the properties below are optional
  params: {
    paramsKey: 'params',
  },
};

Properties

params{ [key: string]: string }paramstyping.Mapping[str, str]paramsMap<String, String>ParamsIDictionary<string, string>Params*map[string]*string= {} No options provided#

Any parameters to pass into the docker cache backend configuration.

Refer to https://docs.docker.com/build/cache/backends/ for cache backend configuration.

example

declare const branch: string;

const params = {
  ref: `12345678.dkr.ecr.us-west-2.amazonaws.com/cache:${branch}`,
  mode: "max",
};

typestringtypestrtypeStringTypestringType*string= unspecifiedrequired#

The type of cache to use.

Refer to https://docs.docker.com/build/cache/backends/ for full list of backends.

example

'registry'