Class DomainMembership

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

An Active Directory Domain membership record associated with the DB instance or cluster.

See Also:

  • Method Details

    • domain

      public final String domain()

      The identifier of the Active Directory Domain.

      Returns:
      The identifier of the Active Directory Domain.

    • status

      public final String status()

      The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

      Returns:
      The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

    • fqdn

      public final String fqdn()

      The fully qualified domain name (FQDN) of the Active Directory Domain.

      Returns:
      The fully qualified domain name (FQDN) of the Active Directory Domain.

    • iamRoleName

      public final String iamRoleName()

      The name of the IAM role used when making API calls to the Directory Service.

      Returns:
      The name of the IAM role used when making API calls to the Directory Service.

    • ou

      public final String ou()

      The Active Directory organizational unit for the DB instance or cluster.

      Returns:
      The Active Directory organizational unit for the DB instance or cluster.

    • authSecretArn

      public final String authSecretArn()

      The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

      Returns:
      The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

    • hasDnsIps

      public final boolean hasDnsIps()
      For responses, this returns true if the service returned a value for the DnsIps property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • dnsIps

      public final List<String> dnsIps()

      The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDnsIps() method.

      Returns:
      The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

    • toBuilder

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

    • builder

      public static DomainMembership.Builder builder()

    • serializableBuilderClass

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