Class DockerCacheOption

Options for configuring the Docker cache backend.

Inheritance
System.Object
DockerCacheOption
Implements
Namespace: Amazon.CDK.CloudAssemblySchema
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DockerCacheOption : Object, IDockerCacheOption
Syntax (vb)
Public Class DockerCacheOption
    Inherits Object
    Implements IDockerCacheOption
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Cloud_assembly_schema;

var dockerCacheOption = new DockerCacheOption {
    Type = "type",

    // the properties below are optional
    Params = new Dictionary<string, string> {
        { "paramsKey", "params" }
    }
};

Synopsis

Constructors

DockerCacheOption()

Properties

Params

Any parameters to pass into the docker cache backend configuration.
Type

The type of cache to use.

Constructors

DockerCacheOption()

public DockerCacheOption()

Properties

Params

Any parameters to pass into the docker cache backend configuration.

public IDictionary<string, string> Params { get; set; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Remarks

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

Default: {} No options provided

Examples
string branch;


IDictionary<string, object> params = new Dictionary<string, object> {
    { "ref", $"12345678.dkr.ecr.us-west-2.amazonaws.com/cache:{branch}" },
    { "mode", "max" }
};

Type

The type of cache to use.

public string Type { get; set; }
Property Value

System.String

Remarks

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

Default: - unspecified

Examples
"registry";

Implements