aws-cdk-lib.DockerCacheOption

interface DockerCacheOption

LanguageType name
.NETAmazon.CDK.DockerCacheOption
Gogithub.com/aws/aws-cdk-go/awscdk/v2#DockerCacheOption
Javasoftware.amazon.awscdk.DockerCacheOption
Pythonaws_cdk.DockerCacheOption
TypeScript (source)aws-cdk-lib » DockerCacheOption

Options for configuring the Docker cache backend.

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

NameTypeDescription
typestringThe type of cache to use.
params?{ [string]: string }Any parameters to pass into the docker cache backend configuration.

type

Type: string

The type of cache to use.

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

'registry'

params?

Type: { [string]: string } (optional, default: {} 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",
};