Class RegistryCredential

java.lang.Object
software.amazon.awssdk.services.codebuild.model.RegistryCredential
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RegistryCredential.Builder,RegistryCredential>
@Generated("software.amazon.awssdk:codegen") public final class RegistryCredential extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RegistryCredential.Builder,RegistryCredential>

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 Secrets Manager Sample for CodeBuild.

See Also:

  • Method Details

    • credential

      public final String credential()

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

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

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

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

    • credentialProvider

      public final CredentialProviderType credentialProvider()

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

      If the service returns an enum value that is not available in the current SDK version, credentialProvider will return CredentialProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from credentialProviderAsString().

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

    • credentialProviderAsString

      public final String credentialProviderAsString()

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

      If the service returns an enum value that is not available in the current SDK version, credentialProvider will return CredentialProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from credentialProviderAsString().

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

    • toBuilder

      public RegistryCredential.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RegistryCredential.Builder,RegistryCredential>
      Returns:
      a builder for type T

    • builder

      public static RegistryCredential.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RegistryCredential.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.