software.amazon.awscdk.services.codebuild

Interface CfnProject.RegistryCredentialProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProject.RegistryCredentialProperty.Jsii$Proxy

Enclosing class:

CfnProject

@Stability(value=Stable)
public static interface CfnProject.RegistryCredentialProperty
extends software.amazon.jsii.JsiiSerializable

`RegistryCredential` is a property of the [AWS CodeBuild Project Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html) 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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codebuild.*;
 RegistryCredentialProperty registryCredentialProperty = RegistryCredentialProperty.builder()
         .credential("credential")
         .credentialProvider("credentialProvider")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnProject.RegistryCredentialProperty.Builder A builder for CfnProject.RegistryCredentialProperty
static class	CfnProject.RegistryCredentialProperty.Jsii$Proxy An implementation for CfnProject.RegistryCredentialProperty

Method Summary

Modifier and Type	Method and Description
static CfnProject.RegistryCredentialProperty.Builder	builder()
String	getCredential() The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager .
String	getCredentialProvider() The service that created the credentials to access a private Docker registry.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCredential

@Stability(value=Stable)
 @NotNull
String getCredential()

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 .

getCredentialProvider

@Stability(value=Stable)
 @NotNull
String getCredentialProvider()

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

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

builder

@Stability(value=Stable)
static CfnProject.RegistryCredentialProperty.Builder builder()

Returns:

a CfnProject.RegistryCredentialProperty.Builder of CfnProject.RegistryCredentialProperty