|
199 | 199 | "refs": { |
200 | 200 | } |
201 | 201 | }, |
| 202 | + "CredentialProviderType": { |
| 203 | + "base": null, |
| 204 | + "refs": { |
| 205 | + "RegistryCredential$credentialProvider": "<p> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. </p>" |
| 206 | + } |
| 207 | + }, |
202 | 208 | "DeleteProjectInput": { |
203 | 209 | "base": null, |
204 | 210 | "refs": { |
|
298 | 304 | "StartBuildInput$gitCloneDepthOverride": "<p>The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.</p>" |
299 | 305 | } |
300 | 306 | }, |
| 307 | + "ImagePullCredentialsType": { |
| 308 | + "base": null, |
| 309 | + "refs": { |
| 310 | + "ProjectEnvironment$imagePullCredentialsType": "<p> The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: </p> <ul> <li> <p> <code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. </p> </li> <li> <p> <code>SERVICE_ROLE</code> specifies that AWS CodeBuild uses your build project's service role. </p> </li> </ul> <p> When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. </p>", |
| 311 | + "StartBuildInput$imagePullCredentialsTypeOverride": "<p> The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: </p> <ul> <li> <p> <code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.</p> </li> <li> <p> <code>SERVICE_ROLE</code> specifies that AWS CodeBuild uses your build project's service role. </p> </li> </ul> <p> When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials. </p>" |
| 312 | + } |
| 313 | + }, |
301 | 314 | "ImageVersions": { |
302 | 315 | "base": null, |
303 | 316 | "refs": { |
|
446 | 459 | "NetworkInterface$networkInterfaceId": "<p>The ID of the network interface.</p>", |
447 | 460 | "Project$serviceRole": "<p>The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</p>", |
448 | 461 | "Project$encryptionKey": "<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>This is expressed either as the Amazon Resource Name (ARN) of the CMK or, if specified, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>", |
449 | | - "ProjectEnvironment$image": "<p>The ID of the Docker image to use for this build project.</p>", |
| 462 | + "ProjectEnvironment$image": "<p>The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:</p> <ul> <li> <p>For an image tag: <code>registry/repository:tag</code>. For example, to specify an image with the tag \"latest,\" use <code>registry/repository:latest</code>.</p> </li> <li> <p>For an image digest: <code>registry/repository@digest</code>. For example, to specify an image with the digest \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use <code>registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>.</p> </li> </ul>", |
450 | 463 | "ProjectNames$member": null, |
| 464 | + "RegistryCredential$credential": "<p> The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. </p> <note> <p> The <code>credential</code> can use the name of the credentials only if they exist in your current region. </p> </note>", |
451 | 465 | "SecurityGroupIds$member": null, |
452 | 466 | "SourceCredentialsInfo$arn": "<p> The Amazon Resource Name (ARN) of the token. </p>", |
453 | 467 | "StartBuildInput$projectName": "<p>The name of the AWS CodeBuild build project to start running a build.</p>", |
|
610 | 624 | "BatchGetProjectsOutput$projects": "<p>Information about the requested build projects.</p>" |
611 | 625 | } |
612 | 626 | }, |
| 627 | + "RegistryCredential": { |
| 628 | + "base": "<p> Information about credentials that provide access to a private Docker registry. When this is set: </p> <ul> <li> <p> <code>imagePullCredentialsType</code> must be set to <code>SERVICE_ROLE</code>. </p> </li> <li> <p> images cannot be curated or an Amazon ECR image.</p> </li> </ul> <p> For more information, see <a href=\"http://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html\">Private Registry with AWS Secrets Manager Samle for AWS CodeBuild</a>. </p>", |
| 629 | + "refs": { |
| 630 | + "ProjectEnvironment$registryCredential": "<p> The credentials for access to a private registry.</p>", |
| 631 | + "StartBuildInput$registryCredentialOverride": "<p> The credentials for access to a private registry. </p>" |
| 632 | + } |
| 633 | + }, |
613 | 634 | "ResourceAlreadyExistsException": { |
614 | 635 | "base": "<p>The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.</p>", |
615 | 636 | "refs": { |
|
0 commit comments