AwsAmazonMqBrokerLdapServerMetadataDetails (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.securityhub.model.AwsAmazonMqBrokerLdapServerMetadataDetails

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AwsAmazonMqBrokerLdapServerMetadataDetails
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AwsAmazonMqBrokerLdapServerMetadataDetails()

Constructors
Constructor and Description
`AwsAmazonMqBrokerLdapServerMetadataDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsAmazonMqBrokerLdapServerMetadataDetails`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getHosts()` Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
`String`	`getRoleBase()` The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
`String`	`getRoleName()` The group name attribute in a role entry whose value is the name of that role.
`String`	`getRoleSearchMatching()` The LDAP search filter used to find roles within the `roleBase`.
`Boolean`	`getRoleSearchSubtree()` The directory search scope for the role.
`String`	`getServiceAccountUsername()` A username for the service account, which is an account in your LDAP server that has access to initiate a connection.
`String`	`getUserBase()` Selects a particular subtree of the directory information tree (DIT) to search for user entries.
`String`	`getUserRoleName()` The name of the LDAP attribute in the user's directory entry for the user's group membership.
`String`	`getUserSearchMatching()` The LDAP search filter used to find users within the `userBase`.
`Boolean`	`getUserSearchSubtree()` The directory search scope for the user.
`int`	`hashCode()`
`Boolean`	`isRoleSearchSubtree()` The directory search scope for the role.
`Boolean`	`isUserSearchSubtree()` The directory search scope for the user.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setHosts(Collection<String> hosts)` Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
`void`	`setRoleBase(String roleBase)` The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
`void`	`setRoleName(String roleName)` The group name attribute in a role entry whose value is the name of that role.
`void`	`setRoleSearchMatching(String roleSearchMatching)` The LDAP search filter used to find roles within the `roleBase`.
`void`	`setRoleSearchSubtree(Boolean roleSearchSubtree)` The directory search scope for the role.
`void`	`setServiceAccountUsername(String serviceAccountUsername)` A username for the service account, which is an account in your LDAP server that has access to initiate a connection.
`void`	`setUserBase(String userBase)` Selects a particular subtree of the directory information tree (DIT) to search for user entries.
`void`	`setUserRoleName(String userRoleName)` The name of the LDAP attribute in the user's directory entry for the user's group membership.
`void`	`setUserSearchMatching(String userSearchMatching)` The LDAP search filter used to find users within the `userBase`.
`void`	`setUserSearchSubtree(Boolean userSearchSubtree)` The directory search scope for the user.
`String`	`toString()` Returns a string representation of this object.
`AwsAmazonMqBrokerLdapServerMetadataDetails`	`withHosts(Collection<String> hosts)` Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
`AwsAmazonMqBrokerLdapServerMetadataDetails`	`withHosts(String... hosts)` Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
`AwsAmazonMqBrokerLdapServerMetadataDetails`	`withRoleBase(String roleBase)` The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
`AwsAmazonMqBrokerLdapServerMetadataDetails`	`withRoleName(String roleName)` The group name attribute in a role entry whose value is the name of that role.
`AwsAmazonMqBrokerLdapServerMetadataDetails`	`withRoleSearchMatching(String roleSearchMatching)` The LDAP search filter used to find roles within the `roleBase`.
`AwsAmazonMqBrokerLdapServerMetadataDetails`	`withRoleSearchSubtree(Boolean roleSearchSubtree)` The directory search scope for the role.
`AwsAmazonMqBrokerLdapServerMetadataDetails`	`withServiceAccountUsername(String serviceAccountUsername)` A username for the service account, which is an account in your LDAP server that has access to initiate a connection.
`AwsAmazonMqBrokerLdapServerMetadataDetails`	`withUserBase(String userBase)` Selects a particular subtree of the directory information tree (DIT) to search for user entries.
`AwsAmazonMqBrokerLdapServerMetadataDetails`	`withUserRoleName(String userRoleName)` The name of the LDAP attribute in the user's directory entry for the user's group membership.
`AwsAmazonMqBrokerLdapServerMetadataDetails`	`withUserSearchMatching(String userSearchMatching)` The LDAP search filter used to find users within the `userBase`.
`AwsAmazonMqBrokerLdapServerMetadataDetails`	`withUserSearchSubtree(Boolean userSearchSubtree)` The directory search scope for the user.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AwsAmazonMqBrokerLdapServerMetadataDetails
```
public AwsAmazonMqBrokerLdapServerMetadataDetails()
```
- Method Detail
  - getHosts
```
public List<String> getHosts()
```
    Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
    
    Returns:
    
    Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
  - setHosts
```
public void setHosts(Collection<String> hosts)
```
    Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
    
    Parameters:
    
    hosts - Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
  - withHosts
```
public AwsAmazonMqBrokerLdapServerMetadataDetails withHosts(String... hosts)
```
    Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
    
    NOTE: This method appends the values to the existing list (if any). Use setHosts(java.util.Collection) or withHosts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    hosts - Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withHosts
```
public AwsAmazonMqBrokerLdapServerMetadataDetails withHosts(Collection<String> hosts)
```
    Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
    
    Parameters:
    
    hosts - Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleBase
```
public void setRoleBase(String roleBase)
```
    The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
    
    Parameters:
    
    roleBase - The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
  - getRoleBase
```
public String getRoleBase()
```
    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.
  - withRoleBase
```
public AwsAmazonMqBrokerLdapServerMetadataDetails withRoleBase(String roleBase)
```
    The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
    
    Parameters:
    
    roleBase - The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleName
```
public void setRoleName(String roleName)
```
    The group name attribute in a role entry whose value is the name of that role.
    
    Parameters:
    
    roleName - The group name attribute in a role entry whose value is the name of that role.
  - getRoleName
```
public String getRoleName()
```
    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.
  - withRoleName
```
public AwsAmazonMqBrokerLdapServerMetadataDetails withRoleName(String roleName)
```
    The group name attribute in a role entry whose value is the name of that role.
    
    Parameters:
    
    roleName - The group name attribute in a role entry whose value is the name of that role.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleSearchMatching
```
public void setRoleSearchMatching(String roleSearchMatching)
```
    The LDAP search filter used to find roles within the roleBase.
    
    Parameters:
    
    roleSearchMatching - The LDAP search filter used to find roles within the roleBase.
  - getRoleSearchMatching
```
public String getRoleSearchMatching()
```
    The LDAP search filter used to find roles within the roleBase.
    
    Returns:
    
    The LDAP search filter used to find roles within the roleBase.
  - withRoleSearchMatching
```
public AwsAmazonMqBrokerLdapServerMetadataDetails withRoleSearchMatching(String roleSearchMatching)
```
    The LDAP search filter used to find roles within the roleBase.
    
    Parameters:
    
    roleSearchMatching - The LDAP search filter used to find roles within the roleBase.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleSearchSubtree
```
public void setRoleSearchSubtree(Boolean roleSearchSubtree)
```
    The directory search scope for the role. If set to true, the scope is to search the entire subtree.
    
    Parameters:
    
    roleSearchSubtree - The directory search scope for the role. If set to true, the scope is to search the entire subtree.
  - getRoleSearchSubtree
```
public Boolean getRoleSearchSubtree()
```
    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.
  - withRoleSearchSubtree
```
public AwsAmazonMqBrokerLdapServerMetadataDetails withRoleSearchSubtree(Boolean roleSearchSubtree)
```
    The directory search scope for the role. If set to true, the scope is to search the entire subtree.
    
    Parameters:
    
    roleSearchSubtree - The directory search scope for the role. If set to true, the scope is to search the entire subtree.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRoleSearchSubtree
```
public Boolean isRoleSearchSubtree()
```
    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.
  - setServiceAccountUsername
```
public void setServiceAccountUsername(String serviceAccountUsername)
```
    A username for the service account, which is an account in your LDAP server that has access to initiate a connection.
    
    Parameters:
    
    serviceAccountUsername - A username for the service account, which is an account in your LDAP server that has access to initiate a connection.
  - getServiceAccountUsername
```
public String getServiceAccountUsername()
```
    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.
  - withServiceAccountUsername
```
public AwsAmazonMqBrokerLdapServerMetadataDetails withServiceAccountUsername(String serviceAccountUsername)
```
    A username for the service account, which is an account in your LDAP server that has access to initiate a connection.
    
    Parameters:
    
    serviceAccountUsername - A username for the service account, which is an account in your LDAP server that has access to initiate a connection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserBase
```
public void setUserBase(String userBase)
```
    Selects a particular subtree of the directory information tree (DIT) to search for user entries.
    
    Parameters:
    
    userBase - Selects a particular subtree of the directory information tree (DIT) to search for user entries.
  - getUserBase
```
public String getUserBase()
```
    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.
  - withUserBase
```
public AwsAmazonMqBrokerLdapServerMetadataDetails withUserBase(String userBase)
```
    Selects a particular subtree of the directory information tree (DIT) to search for user entries.
    
    Parameters:
    
    userBase - Selects a particular subtree of the directory information tree (DIT) to search for user entries.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserRoleName
```
public void setUserRoleName(String userRoleName)
```
    The name of the LDAP attribute in the user's directory entry for the user's group membership.
    
    Parameters:
    
    userRoleName - The name of the LDAP attribute in the user's directory entry for the user's group membership.
  - getUserRoleName
```
public String getUserRoleName()
```
    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.
  - withUserRoleName
```
public AwsAmazonMqBrokerLdapServerMetadataDetails withUserRoleName(String userRoleName)
```
    The name of the LDAP attribute in the user's directory entry for the user's group membership.
    
    Parameters:
    
    userRoleName - The name of the LDAP attribute in the user's directory entry for the user's group membership.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserSearchMatching
```
public void setUserSearchMatching(String userSearchMatching)
```
    The LDAP search filter used to find users within the userBase.
    
    Parameters:
    
    userSearchMatching - The LDAP search filter used to find users within the userBase.
  - getUserSearchMatching
```
public String getUserSearchMatching()
```
    The LDAP search filter used to find users within the userBase.
    
    Returns:
    
    The LDAP search filter used to find users within the userBase.
  - withUserSearchMatching
```
public AwsAmazonMqBrokerLdapServerMetadataDetails withUserSearchMatching(String userSearchMatching)
```
    The LDAP search filter used to find users within the userBase.
    
    Parameters:
    
    userSearchMatching - The LDAP search filter used to find users within the userBase.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserSearchSubtree
```
public void setUserSearchSubtree(Boolean userSearchSubtree)
```
    The directory search scope for the user. If set to true, the scope is to search the entire subtree.
    
    Parameters:
    
    userSearchSubtree - The directory search scope for the user. If set to true, the scope is to search the entire subtree.
  - getUserSearchSubtree
```
public Boolean getUserSearchSubtree()
```
    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.
  - withUserSearchSubtree
```
public AwsAmazonMqBrokerLdapServerMetadataDetails withUserSearchSubtree(Boolean userSearchSubtree)
```
    The directory search scope for the user. If set to true, the scope is to search the entire subtree.
    
    Parameters:
    
    userSearchSubtree - The directory search scope for the user. If set to true, the scope is to search the entire subtree.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUserSearchSubtree
```
public Boolean isUserSearchSubtree()
```
    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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AwsAmazonMqBrokerLdapServerMetadataDetails clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class AwsAmazonMqBrokerLdapServerMetadataDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AwsAmazonMqBrokerLdapServerMetadataDetails

Method Detail

getHosts

setHosts

withHosts

withHosts

setRoleBase

getRoleBase

withRoleBase

setRoleName

getRoleName

withRoleName

setRoleSearchMatching

getRoleSearchMatching

withRoleSearchMatching

setRoleSearchSubtree

getRoleSearchSubtree

withRoleSearchSubtree

isRoleSearchSubtree

setServiceAccountUsername

getServiceAccountUsername

withServiceAccountUsername

setUserBase

getUserBase

withUserBase

setUserRoleName

getUserRoleName

withUserRoleName

setUserSearchMatching

getUserSearchMatching

withUserSearchMatching

setUserSearchSubtree

getUserSearchSubtree

withUserSearchSubtree

isUserSearchSubtree

toString

equals

hashCode

clone

marshall