Amazon CodeBuild · JSON Structure

Amazon Codebuild Registry Credential Structure

Information about credentials that provide access to a private Docker registry. When this is set:

For more information, see Private Registry with Secrets Manager Sample for CodeBuild.

Type: object Properties: 2 Required: 2
AmazonCI/CDBuildContinuous IntegrationDevOpsTesting

RegistryCredential is a JSON Structure definition published by Amazon CodeBuild, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

credential credentialProvider

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codebuild/refs/heads/main/json-structure/amazon-codebuild-registry-credential-structure.json",
  "name": "RegistryCredential",
  "description": "<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=\"https://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html\">Private Registry with Secrets Manager Sample for CodeBuild</a>. </p>",
  "type": "object",
  "properties": {
    "credential": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "<p> The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. </p> <note> <p> The <code>credential</code> can use the name of the credentials only if they exist in your current Amazon Web Services Region. </p> </note>"
        }
      ]
    },
    "credentialProvider": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CredentialProviderType"
        },
        {
          "description": " The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager. "
        }
      ]
    }
  },
  "required": [
    "credential",
    "credentialProvider"
  ]
}