Interface DockerCacheOption

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
DockerCacheOption.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:33:56.327Z") @Stability(Stable) public interface DockerCacheOption extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.*;
 DockerCacheOption dockerCacheOption = DockerCacheOption.builder()
         .type("type")
         // the properties below are optional
         .params(Map.of(
                 "paramsKey", "params"))
         .build();
 
  • Method Details

    • getType

      @Stability(Stable) @NotNull String getType()
      The type of cache to use.

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

      Default: - unspecified

      Example:

       "registry";
       
    • getParams

      @Stability(Stable) @Nullable default Map<String,String> getParams()
      Any parameters to pass into the docker cache backend configuration.

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

      Default: {} No options provided

      Example:

       String branch;
       Map<String, Object> params = Map.of(
               "ref", String.format("12345678.dkr.ecr.us-west-2.amazonaws.com/cache:%s", branch),
               "mode", "max");
       
    • builder

      @Stability(Stable) static DockerCacheOption.Builder builder()
      Returns:
      a DockerCacheOption.Builder of DockerCacheOption