Class: AWSCDK::CodeBuild::CfnProject::RegistryCredentialProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::CodeBuild::CfnProject::RegistryCredentialProperty

Defined in:

code_build/cfn_project.rb

Overview

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:.

• image_pull_credentials_type 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

Instance Attribute Summary

• #credential ⇒ String readonly

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

• #credential_provider ⇒ String readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(credential:, credential_provider:) ⇒ RegistryCredentialProperty constructor

  A new instance of RegistryCredentialProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(credential:, credential_provider:) ⇒ RegistryCredentialProperty

Returns a new instance of RegistryCredentialProperty.

Parameters:

• credential (String) —

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

• credential_provider (String) —

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

# File 'code_build/cfn_project.rb', line 2019

def initialize(credential:, credential_provider:)
  @credential = credential
  Jsii::Type.check_type(@credential, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "credential")
  @credential_provider = credential_provider
  Jsii::Type.check_type(@credential_provider, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "credentialProvider")
end

Instance Attribute Details

#credential ⇒ String (readonly)

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 .

Returns:

• (String)

See Also:

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

# File 'code_build/cfn_project.rb', line 2032

def credential
  @credential
end

#credential_provider ⇒ String (readonly)

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

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

Returns:

• (String)

See Also:

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

# File 'code_build/cfn_project.rb', line 2039

def credential_provider
  @credential_provider
end

Class Method Details

.jsii_properties ⇒ Object

# File 'code_build/cfn_project.rb', line 2041

def self.jsii_properties
  {
    :credential => "credential",
    :credential_provider => "credentialProvider",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'code_build/cfn_project.rb', line 2048

def to_jsii
  result = {}
  result.merge!({
    "credential" => @credential,
    "credentialProvider" => @credential_provider,
  })
  result.compact
end