aws-cdk-lib.aws_codebuild.CfnProject.RegistryCredentialProperty

RegistryCredentialProperty Struct

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 .

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
const registryCredentialProperty: codebuild.CfnProject.RegistryCredentialProperty = {
  credential: 'credential',
  credentialProvider: 'credentialProvider',
};

Properties

credentialstringcredentialstrcredentialStringCredentialstringCredential*stringrequired#

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

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

credentialProviderstringcredential_providerstrcredentialProviderStringCredentialProviderstringCredentialProvider*stringrequired#

The service that created the credentials to access a private Docker registry.

The valid value, SECRETS_MANAGER, is for AWS Secrets Manager .