2.233.0

interface RegistryCredentialProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.CodeBuild.Mixins.CfnProjectPropsMixin.RegistryCredentialProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscodebuild/mixins#CfnProjectPropsMixin_RegistryCredentialProperty
Javasoftware.amazon.awscdk.mixins.preview.services.codebuild.mixins.CfnProjectPropsMixin.RegistryCredentialProperty
Pythonaws_cdk.mixins_preview.aws_codebuild.mixins.CfnProjectPropsMixin.RegistryCredentialProperty
TypeScript @aws-cdk/mixins-preview » aws_codebuild » mixins » CfnProjectPropsMixin » RegistryCredentialProperty

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-registrycredential.html

Example

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

Properties

NameTypeDescription
credential?stringThe Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager .
credentialProvider?stringThe service that created the credentials to access a private Docker registry.

credential?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-registrycredential.html#cfn-codebuild-project-registrycredential-credential

credentialProvider?

Type: string (optional)

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-registrycredential.html#cfn-codebuild-project-registrycredential-credentialprovider

← PreviousNext →