Package software.amazon.awssdk.services.mq.model

Interface LdapServerMetadataOutput.Builder

    • Method Detail

      • hosts

        LdapServerMetadataOutput.Builder hosts​(Collection<String> hosts)

        Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.

        Parameters:
        hosts - Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hosts

        LdapServerMetadataOutput.Builder hosts​(String... hosts)

        Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.

        Parameters:
        hosts - Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleBase

        LdapServerMetadataOutput.Builder roleBase​(String roleBase)

        The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.

        Parameters:
        roleBase - The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleName

        LdapServerMetadataOutput.Builder roleName​(String roleName)

        Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.

        Parameters:
        roleName - Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleSearchMatching

        LdapServerMetadataOutput.Builder roleSearchMatching​(String roleSearchMatching)

        The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.

        Parameters:
        roleSearchMatching - The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleSearchSubtree

        LdapServerMetadataOutput.Builder roleSearchSubtree​(Boolean roleSearchSubtree)

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

        Parameters:
        roleSearchSubtree - The directory search scope for the role. If set to true, scope is to search the entire subtree.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serviceAccountUsername

        LdapServerMetadataOutput.Builder serviceAccountUsername​(String serviceAccountUsername)

        Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.

        Parameters:
        serviceAccountUsername - Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userBase

        LdapServerMetadataOutput.Builder userBase​(String userBase)

        Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.

        Parameters:
        userBase - Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userRoleName

        LdapServerMetadataOutput.Builder userRoleName​(String userRoleName)

        Specifies the name of the LDAP attribute for the user group membership.

        Parameters:
        userRoleName - Specifies the name of the LDAP attribute for the user group membership.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userSearchMatching

        LdapServerMetadataOutput.Builder userSearchMatching​(String userSearchMatching)

        The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.

        Parameters:
        userSearchMatching - The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userSearchSubtree

        LdapServerMetadataOutput.Builder userSearchSubtree​(Boolean userSearchSubtree)

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

        Parameters:
        userSearchSubtree - The directory search scope for the user. If set to true, scope is to search the entire subtree.
        Returns:
        Returns a reference to this object so that method calls can be chained together.