Class ClusterMasterUserSecret

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

Contains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.

See Also:

  • Method Details

    • secretArn

      public final String secretArn()

      The Amazon Resource Name (ARN) of the secret.

      Returns:
      The Amazon Resource Name (ARN) of the secret.

    • secretStatus

      public final String secretStatus()

      The status of the secret.

      The possible status values include the following:

      • creating - The secret is being created.

      • active - The secret is available for normal use and rotation.

      • rotating - The secret is being rotated.

      • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret.

        When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.

      Returns:
      The status of the secret.

      The possible status values include the following:

      • creating - The secret is being created.

      • active - The secret is available for normal use and rotation.

      • rotating - The secret is being rotated.

      • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret.

        When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Web Services KMS key identifier that is used to encrypt the secret.

      Returns:
      The Amazon Web Services KMS key identifier that is used to encrypt the secret.

    • toBuilder

      public ClusterMasterUserSecret.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<ClusterMasterUserSecret.Builder,ClusterMasterUserSecret>
      Returns:
      a builder for type T

    • builder

      public static ClusterMasterUserSecret.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ClusterMasterUserSecret.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.