Class AwsAmazonMqBrokerLdapServerMetadataDetails

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

The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.

See Also:

  • Method Details

    • hasHosts

      public final boolean hasHosts()
      For responses, this returns true if the service returned a value for the Hosts 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.

    • hosts

      public final List<String> hosts()

      Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.

      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 hasHosts() method.

      Returns:
      Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.

    • roleBase

      public final String roleBase()

      The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.

      Returns:
      The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.

    • roleName

      public final String roleName()

      The group name attribute in a role entry whose value is the name of that role.

      Returns:
      The group name attribute in a role entry whose value is the name of that role.

    • roleSearchMatching

      public final String roleSearchMatching()

      The LDAP search filter used to find roles within the roleBase.

      Returns:
      The LDAP search filter used to find roles within the roleBase.

    • roleSearchSubtree

      public final Boolean roleSearchSubtree()

      The directory search scope for the role. If set to true, the scope is to search the entire subtree.

      Returns:
      The directory search scope for the role. If set to true, the scope is to search the entire subtree.

    • serviceAccountUsername

      public final String serviceAccountUsername()

      A username for the service account, which is an account in your LDAP server that has access to initiate a connection.

      Returns:
      A username for the service account, which is an account in your LDAP server that has access to initiate a connection.

    • userBase

      public final String userBase()

      Selects a particular subtree of the directory information tree (DIT) to search for user entries.

      Returns:
      Selects a particular subtree of the directory information tree (DIT) to search for user entries.

    • userRoleName

      public final String userRoleName()

      The name of the LDAP attribute in the user's directory entry for the user's group membership.

      Returns:
      The name of the LDAP attribute in the user's directory entry for the user's group membership.

    • userSearchMatching

      public final String userSearchMatching()

      The LDAP search filter used to find users within the userBase.

      Returns:
      The LDAP search filter used to find users within the userBase.

    • userSearchSubtree

      public final Boolean userSearchSubtree()

      The directory search scope for the user. If set to true, the scope is to search the entire subtree.

      Returns:
      The directory search scope for the user. If set to true, the scope is to search the entire subtree.

    • toBuilder

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

    • builder

      public static AwsAmazonMqBrokerLdapServerMetadataDetails.Builder builder()

    • serializableBuilderClass

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