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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAwsAmazonMqBrokerLdapServerMetadataDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AwsAmazonMqBrokerLdapServerMetadataDetails.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasHosts()For responses, this returns true if the service returned a value for the Hosts property.List<String>hosts()Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.StringroleBase()The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.StringroleName()The group name attribute in a role entry whose value is the name of that role.StringroleSearchMatching()The LDAP search filter used to find roles within theroleBase.BooleanroleSearchSubtree()The directory search scope for the role.List<SdkField<?>>sdkFields()static Class<? extends AwsAmazonMqBrokerLdapServerMetadataDetails.Builder>serializableBuilderClass()StringserviceAccountUsername()A username for the service account, which is an account in your LDAP server that has access to initiate a connection.AwsAmazonMqBrokerLdapServerMetadataDetails.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringuserBase()Selects a particular subtree of the directory information tree (DIT) to search for user entries.StringuserRoleName()The name of the LDAP attribute in the user's directory entry for the user's group membership.StringuserSearchMatching()The LDAP search filter used to find users within theuserBase.BooleanuserSearchSubtree()The directory search scope for the user.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AwsAmazonMqBrokerLdapServerMetadataDetails.Builder,AwsAmazonMqBrokerLdapServerMetadataDetails>
-
builder
public static AwsAmazonMqBrokerLdapServerMetadataDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends AwsAmazonMqBrokerLdapServerMetadataDetails.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-