AWS CloudFormation
User Guide (Version )

AWS::CodeBuild::Project RegistryCredential

RegistryCredential is a property of the AWS CodeBuild Project Environment property type that specifies 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Credential" : String, "CredentialProvider" : String }

YAML

Credential: String CredentialProvider: String

Properties

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.

Required: Yes

Type: String

Minimum: 1

Update requires: No interruption

CredentialProvider

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

Required: Yes

Type: String

Allowed Values: SECRETS_MANAGER

Update requires: No interruption

See Also

On this page: