feat(client-codebuild): This release adds support for cacheNamespace in ProjectCache

awstools · awstools · commit add93bd50f87 · 2025-03-28T18:16:13.000Z
diff --git a/clients/client-codebuild/src/commands/BatchGetBuildBatchesCommand.ts b/clients/client-codebuild/src/commands/BatchGetBuildBatchesCommand.ts
@@ -143,6 +143,7 @@ export interface BatchGetBuildBatchesCommandOutput extends BatchGetBuildBatchesO
  * //         modes: [ // ProjectCacheModes
  * //           "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  * //         ],
+ * //         cacheNamespace: "STRING_VALUE",
  * //       },
  * //       environment: { // ProjectEnvironment
  * //         type: "WINDOWS_CONTAINER" || "LINUX_CONTAINER" || "LINUX_GPU_CONTAINER" || "ARM_CONTAINER" || "WINDOWS_SERVER_2019_CONTAINER" || "LINUX_LAMBDA_CONTAINER" || "ARM_LAMBDA_CONTAINER" || "LINUX_EC2" || "ARM_EC2" || "WINDOWS_EC2" || "MAC_ARM", // required
diff --git a/clients/client-codebuild/src/commands/BatchGetBuildsCommand.ts b/clients/client-codebuild/src/commands/BatchGetBuildsCommand.ts
@@ -144,6 +144,7 @@ export interface BatchGetBuildsCommandOutput extends BatchGetBuildsOutput, __Met
  * //         modes: [ // ProjectCacheModes
  * //           "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  * //         ],
+ * //         cacheNamespace: "STRING_VALUE",
  * //       },
  * //       environment: { // ProjectEnvironment
  * //         type: "WINDOWS_CONTAINER" || "LINUX_CONTAINER" || "LINUX_GPU_CONTAINER" || "ARM_CONTAINER" || "WINDOWS_SERVER_2019_CONTAINER" || "LINUX_LAMBDA_CONTAINER" || "ARM_LAMBDA_CONTAINER" || "LINUX_EC2" || "ARM_EC2" || "WINDOWS_EC2" || "MAC_ARM", // required
diff --git a/clients/client-codebuild/src/commands/BatchGetProjectsCommand.ts b/clients/client-codebuild/src/commands/BatchGetProjectsCommand.ts
@@ -129,6 +129,7 @@ export interface BatchGetProjectsCommandOutput extends BatchGetProjectsOutput, _
  * //         modes: [ // ProjectCacheModes
  * //           "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  * //         ],
+ * //         cacheNamespace: "STRING_VALUE",
  * //       },
  * //       environment: { // ProjectEnvironment
  * //         type: "WINDOWS_CONTAINER" || "LINUX_CONTAINER" || "LINUX_GPU_CONTAINER" || "ARM_CONTAINER" || "WINDOWS_SERVER_2019_CONTAINER" || "LINUX_LAMBDA_CONTAINER" || "ARM_LAMBDA_CONTAINER" || "LINUX_EC2" || "ARM_EC2" || "WINDOWS_EC2" || "MAC_ARM", // required
diff --git a/clients/client-codebuild/src/commands/CreateProjectCommand.ts b/clients/client-codebuild/src/commands/CreateProjectCommand.ts
@@ -119,6 +119,7 @@ export interface CreateProjectCommandOutput extends CreateProjectOutput, __Metad
  *     modes: [ // ProjectCacheModes
  *       "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  *     ],
+ *     cacheNamespace: "STRING_VALUE",
  *   },
  *   environment: { // ProjectEnvironment
  *     type: "WINDOWS_CONTAINER" || "LINUX_CONTAINER" || "LINUX_GPU_CONTAINER" || "ARM_CONTAINER" || "WINDOWS_SERVER_2019_CONTAINER" || "LINUX_LAMBDA_CONTAINER" || "ARM_LAMBDA_CONTAINER" || "LINUX_EC2" || "ARM_EC2" || "WINDOWS_EC2" || "MAC_ARM", // required
@@ -296,6 +297,7 @@ export interface CreateProjectCommandOutput extends CreateProjectOutput, __Metad
  * //       modes: [ // ProjectCacheModes
  * //         "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  * //       ],
+ * //       cacheNamespace: "STRING_VALUE",
  * //     },
  * //     environment: { // ProjectEnvironment
  * //       type: "WINDOWS_CONTAINER" || "LINUX_CONTAINER" || "LINUX_GPU_CONTAINER" || "ARM_CONTAINER" || "WINDOWS_SERVER_2019_CONTAINER" || "LINUX_LAMBDA_CONTAINER" || "ARM_LAMBDA_CONTAINER" || "LINUX_EC2" || "ARM_EC2" || "WINDOWS_EC2" || "MAC_ARM", // required
diff --git a/clients/client-codebuild/src/commands/RetryBuildBatchCommand.ts b/clients/client-codebuild/src/commands/RetryBuildBatchCommand.ts
@@ -142,6 +142,7 @@ export interface RetryBuildBatchCommandOutput extends RetryBuildBatchOutput, __M
  * //       modes: [ // ProjectCacheModes
  * //         "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  * //       ],
+ * //       cacheNamespace: "STRING_VALUE",
  * //     },
  * //     environment: { // ProjectEnvironment
  * //       type: "WINDOWS_CONTAINER" || "LINUX_CONTAINER" || "LINUX_GPU_CONTAINER" || "ARM_CONTAINER" || "WINDOWS_SERVER_2019_CONTAINER" || "LINUX_LAMBDA_CONTAINER" || "ARM_LAMBDA_CONTAINER" || "LINUX_EC2" || "ARM_EC2" || "WINDOWS_EC2" || "MAC_ARM", // required
diff --git a/clients/client-codebuild/src/commands/RetryBuildCommand.ts b/clients/client-codebuild/src/commands/RetryBuildCommand.ts
@@ -142,6 +142,7 @@ export interface RetryBuildCommandOutput extends RetryBuildOutput, __MetadataBea
  * //       modes: [ // ProjectCacheModes
  * //         "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  * //       ],
+ * //       cacheNamespace: "STRING_VALUE",
  * //     },
  * //     environment: { // ProjectEnvironment
  * //       type: "WINDOWS_CONTAINER" || "LINUX_CONTAINER" || "LINUX_GPU_CONTAINER" || "ARM_CONTAINER" || "WINDOWS_SERVER_2019_CONTAINER" || "LINUX_LAMBDA_CONTAINER" || "ARM_LAMBDA_CONTAINER" || "LINUX_EC2" || "ARM_EC2" || "WINDOWS_EC2" || "MAC_ARM", // required
diff --git a/clients/client-codebuild/src/commands/StartBuildBatchCommand.ts b/clients/client-codebuild/src/commands/StartBuildBatchCommand.ts
@@ -122,6 +122,7 @@ export interface StartBuildBatchCommandOutput extends StartBuildBatchOutput, __M
  *     modes: [ // ProjectCacheModes
  *       "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  *     ],
+ *     cacheNamespace: "STRING_VALUE",
  *   },
  *   serviceRoleOverride: "STRING_VALUE",
  *   privilegedModeOverride: true || false,
@@ -266,6 +267,7 @@ export interface StartBuildBatchCommandOutput extends StartBuildBatchOutput, __M
  * //       modes: [ // ProjectCacheModes
  * //         "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  * //       ],
+ * //       cacheNamespace: "STRING_VALUE",
  * //     },
  * //     environment: { // ProjectEnvironment
  * //       type: "WINDOWS_CONTAINER" || "LINUX_CONTAINER" || "LINUX_GPU_CONTAINER" || "ARM_CONTAINER" || "WINDOWS_SERVER_2019_CONTAINER" || "LINUX_LAMBDA_CONTAINER" || "ARM_LAMBDA_CONTAINER" || "LINUX_EC2" || "ARM_EC2" || "WINDOWS_EC2" || "MAC_ARM", // required
diff --git a/clients/client-codebuild/src/commands/StartBuildCommand.ts b/clients/client-codebuild/src/commands/StartBuildCommand.ts
@@ -129,6 +129,7 @@ export interface StartBuildCommandOutput extends StartBuildOutput, __MetadataBea
  *     modes: [ // ProjectCacheModes
  *       "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  *     ],
+ *     cacheNamespace: "STRING_VALUE",
  *   },
  *   serviceRoleOverride: "STRING_VALUE",
  *   privilegedModeOverride: true || false,
@@ -263,6 +264,7 @@ export interface StartBuildCommandOutput extends StartBuildOutput, __MetadataBea
  * //       modes: [ // ProjectCacheModes
  * //         "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  * //       ],
+ * //       cacheNamespace: "STRING_VALUE",
  * //     },
  * //     environment: { // ProjectEnvironment
  * //       type: "WINDOWS_CONTAINER" || "LINUX_CONTAINER" || "LINUX_GPU_CONTAINER" || "ARM_CONTAINER" || "WINDOWS_SERVER_2019_CONTAINER" || "LINUX_LAMBDA_CONTAINER" || "ARM_LAMBDA_CONTAINER" || "LINUX_EC2" || "ARM_EC2" || "WINDOWS_EC2" || "MAC_ARM", // required
diff --git a/clients/client-codebuild/src/commands/StopBuildBatchCommand.ts b/clients/client-codebuild/src/commands/StopBuildBatchCommand.ts
@@ -140,6 +140,7 @@ export interface StopBuildBatchCommandOutput extends StopBuildBatchOutput, __Met
  * //       modes: [ // ProjectCacheModes
  * //         "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  * //       ],
+ * //       cacheNamespace: "STRING_VALUE",
  * //     },
  * //     environment: { // ProjectEnvironment
  * //       type: "WINDOWS_CONTAINER" || "LINUX_CONTAINER" || "LINUX_GPU_CONTAINER" || "ARM_CONTAINER" || "WINDOWS_SERVER_2019_CONTAINER" || "LINUX_LAMBDA_CONTAINER" || "ARM_LAMBDA_CONTAINER" || "LINUX_EC2" || "ARM_EC2" || "WINDOWS_EC2" || "MAC_ARM", // required
diff --git a/clients/client-codebuild/src/commands/StopBuildCommand.ts b/clients/client-codebuild/src/commands/StopBuildCommand.ts
@@ -141,6 +141,7 @@ export interface StopBuildCommandOutput extends StopBuildOutput, __MetadataBeare
  * //       modes: [ // ProjectCacheModes
  * //         "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  * //       ],
+ * //       cacheNamespace: "STRING_VALUE",
  * //     },
  * //     environment: { // ProjectEnvironment
  * //       type: "WINDOWS_CONTAINER" || "LINUX_CONTAINER" || "LINUX_GPU_CONTAINER" || "ARM_CONTAINER" || "WINDOWS_SERVER_2019_CONTAINER" || "LINUX_LAMBDA_CONTAINER" || "ARM_LAMBDA_CONTAINER" || "LINUX_EC2" || "ARM_EC2" || "WINDOWS_EC2" || "MAC_ARM", // required
diff --git a/clients/client-codebuild/src/commands/UpdateProjectCommand.ts b/clients/client-codebuild/src/commands/UpdateProjectCommand.ts
@@ -119,6 +119,7 @@ export interface UpdateProjectCommandOutput extends UpdateProjectOutput, __Metad
  *     modes: [ // ProjectCacheModes
  *       "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  *     ],
+ *     cacheNamespace: "STRING_VALUE",
  *   },
  *   environment: { // ProjectEnvironment
  *     type: "WINDOWS_CONTAINER" || "LINUX_CONTAINER" || "LINUX_GPU_CONTAINER" || "ARM_CONTAINER" || "WINDOWS_SERVER_2019_CONTAINER" || "LINUX_LAMBDA_CONTAINER" || "ARM_LAMBDA_CONTAINER" || "LINUX_EC2" || "ARM_EC2" || "WINDOWS_EC2" || "MAC_ARM", // required
@@ -296,6 +297,7 @@ export interface UpdateProjectCommandOutput extends UpdateProjectOutput, __Metad
  * //       modes: [ // ProjectCacheModes
  * //         "LOCAL_DOCKER_LAYER_CACHE" || "LOCAL_SOURCE_CACHE" || "LOCAL_CUSTOM_CACHE",
  * //       ],
+ * //       cacheNamespace: "STRING_VALUE",
  * //     },
  * //     environment: { // ProjectEnvironment
  * //       type: "WINDOWS_CONTAINER" || "LINUX_CONTAINER" || "LINUX_GPU_CONTAINER" || "ARM_CONTAINER" || "WINDOWS_SERVER_2019_CONTAINER" || "LINUX_LAMBDA_CONTAINER" || "ARM_LAMBDA_CONTAINER" || "LINUX_EC2" || "ARM_EC2" || "WINDOWS_EC2" || "MAC_ARM", // required
diff --git a/clients/client-codebuild/src/models/models_0.ts b/clients/client-codebuild/src/models/models_0.ts
@@ -688,6 +688,14 @@ export interface ProjectCache {
    * @public
    */
   modes?: CacheMode[] | undefined;
+
+  /**
+   * <p>Defines the scope of the cache. You can use this namespace to share a cache across
+   *             multiple projects. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/caching-s3.html#caching-s3-sharing">Cache sharing
+   *                 between projects</a> in the <i>CodeBuild User Guide</i>.</p>
+   * @public
+   */
+  cacheNamespace?: string | undefined;
 }
 
 /**
diff --git a/codegen/sdk-codegen/aws-models/codebuild.json b/codegen/sdk-codegen/aws-models/codebuild.json
@@ -6504,6 +6504,12 @@
           "traits": {
             "smithy.api#documentation": "<p>An array of strings that specify the local cache modes. You can use one or more local\n            cache modes at the same time. This is only used for <code>LOCAL</code> cache\n            types.</p>\n         <p>Possible values are:</p>\n         <dl>\n            <dt>LOCAL_SOURCE_CACHE</dt>\n            <dd>\n               <p>Caches Git metadata for primary and secondary sources. After the cache is\n                        created, subsequent builds pull only the change between commits. This mode\n                        is a good choice for projects with a clean working directory and a source\n                        that is a large Git repository. If you choose this option and your project\n                        does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the\n                        option is ignored. </p>\n            </dd>\n            <dt>LOCAL_DOCKER_LAYER_CACHE</dt>\n            <dd>\n               <p>Caches existing Docker layers. This mode is a good choice for projects\n                        that build or pull large Docker images. It can prevent the performance\n                        issues caused by pulling large Docker images down from the network. </p>\n               <note>\n                  <ul>\n                     <li>\n                        <p>You can use a Docker layer cache in the Linux environment\n                                    only. </p>\n                     </li>\n                     <li>\n                        <p>The <code>privileged</code> flag must be set so that your\n                                    project has the required Docker permissions. </p>\n                     </li>\n                     <li>\n                        <p>You should consider the security implications before you use a\n                                    Docker layer cache. </p>\n                     </li>\n                  </ul>\n               </note>\n            </dd>\n            <dt>LOCAL_CUSTOM_CACHE</dt>\n            <dd>\n               <p>Caches directories you specify in the buildspec file. This mode is a good\n                        choice if your build scenario is not suited to one of the other three local\n                        cache modes. If you use a custom cache: </p>\n               <ul>\n                  <li>\n                     <p>Only directories can be specified for caching. You cannot specify\n                                individual files. </p>\n                  </li>\n                  <li>\n                     <p>Symlinks are used to reference cached directories. </p>\n                  </li>\n                  <li>\n                     <p>Cached directories are linked to your build before it downloads\n                                its project sources. Cached items are overridden if a source item\n                                has the same name. Directories are specified using cache paths in\n                                the buildspec file. </p>\n                  </li>\n               </ul>\n            </dd>\n         </dl>"
           }
+        },
+        "cacheNamespace": {
+          "target": "com.amazonaws.codebuild#String",
+          "traits": {
+            "smithy.api#documentation": "<p>Defines the scope of the cache. You can use this namespace to share a cache across \n            multiple projects. For more information, see <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/caching-s3.html#caching-s3-sharing\">Cache sharing \n                between projects</a> in the <i>CodeBuild User Guide</i>.</p>"
+          }
         }
       },
       "traits": {
