AWS CodeBuild
API Reference (API Version 2016-10-06)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

RegistryCredential

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

  • imagePullCredentialsType must be set to SERVICE_ROLE.

  • images cannot be curated or an Amazon ECR image.

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

Contents

Note

In the following list, the required parameters are described first.

credential

The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.

Note

The credential can use the name of the credentials only if they exist in your current region.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

credentialProvider

The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.

Type: String

Valid Values: SECRETS_MANAGER

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: