You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodeBuild::Types::RegistryCredential

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb

Overview

Note:

When making an API call, you may pass RegistryCredential data as a hash:

{
  credential: "NonEmptyString", # required
  credential_provider: "SECRETS_MANAGER", # required, accepts SECRETS_MANAGER
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#credentialString

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

Returns:

  • (String)


2396
2397
2398
2399
2400
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2396

class RegistryCredential < Struct.new(
  :credential,
  :credential_provider)
  include Aws::Structure
end

#credential_providerString

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

Returns:

  • (String)


2396
2397
2398
2399
2400
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2396

class RegistryCredential < Struct.new(
  :credential,
  :credential_provider)
  include Aws::Structure
end