AWS SDK for C++  1.9.69
AWS SDK for C++
Public Member Functions | List of all members
Aws::MQ::Model::LdapServerMetadataOutput Class Reference

#include <LdapServerMetadataOutput.h>

Public Member Functions

 LdapServerMetadataOutput ()
 
 LdapServerMetadataOutput (Aws::Utils::Json::JsonView jsonValue)
 
LdapServerMetadataOutputoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< Aws::String > & GetHosts () const
 
bool HostsHasBeenSet () const
 
void SetHosts (const Aws::Vector< Aws::String > &value)
 
void SetHosts (Aws::Vector< Aws::String > &&value)
 
LdapServerMetadataOutputWithHosts (const Aws::Vector< Aws::String > &value)
 
LdapServerMetadataOutputWithHosts (Aws::Vector< Aws::String > &&value)
 
LdapServerMetadataOutputAddHosts (const Aws::String &value)
 
LdapServerMetadataOutputAddHosts (Aws::String &&value)
 
LdapServerMetadataOutputAddHosts (const char *value)
 
const Aws::StringGetRoleBase () const
 
bool RoleBaseHasBeenSet () const
 
void SetRoleBase (const Aws::String &value)
 
void SetRoleBase (Aws::String &&value)
 
void SetRoleBase (const char *value)
 
LdapServerMetadataOutputWithRoleBase (const Aws::String &value)
 
LdapServerMetadataOutputWithRoleBase (Aws::String &&value)
 
LdapServerMetadataOutputWithRoleBase (const char *value)
 
const Aws::StringGetRoleName () const
 
bool RoleNameHasBeenSet () const
 
void SetRoleName (const Aws::String &value)
 
void SetRoleName (Aws::String &&value)
 
void SetRoleName (const char *value)
 
LdapServerMetadataOutputWithRoleName (const Aws::String &value)
 
LdapServerMetadataOutputWithRoleName (Aws::String &&value)
 
LdapServerMetadataOutputWithRoleName (const char *value)
 
const Aws::StringGetRoleSearchMatching () const
 
bool RoleSearchMatchingHasBeenSet () const
 
void SetRoleSearchMatching (const Aws::String &value)
 
void SetRoleSearchMatching (Aws::String &&value)
 
void SetRoleSearchMatching (const char *value)
 
LdapServerMetadataOutputWithRoleSearchMatching (const Aws::String &value)
 
LdapServerMetadataOutputWithRoleSearchMatching (Aws::String &&value)
 
LdapServerMetadataOutputWithRoleSearchMatching (const char *value)
 
bool GetRoleSearchSubtree () const
 
bool RoleSearchSubtreeHasBeenSet () const
 
void SetRoleSearchSubtree (bool value)
 
LdapServerMetadataOutputWithRoleSearchSubtree (bool value)
 
const Aws::StringGetServiceAccountUsername () const
 
bool ServiceAccountUsernameHasBeenSet () const
 
void SetServiceAccountUsername (const Aws::String &value)
 
void SetServiceAccountUsername (Aws::String &&value)
 
void SetServiceAccountUsername (const char *value)
 
LdapServerMetadataOutputWithServiceAccountUsername (const Aws::String &value)
 
LdapServerMetadataOutputWithServiceAccountUsername (Aws::String &&value)
 
LdapServerMetadataOutputWithServiceAccountUsername (const char *value)
 
const Aws::StringGetUserBase () const
 
bool UserBaseHasBeenSet () const
 
void SetUserBase (const Aws::String &value)
 
void SetUserBase (Aws::String &&value)
 
void SetUserBase (const char *value)
 
LdapServerMetadataOutputWithUserBase (const Aws::String &value)
 
LdapServerMetadataOutputWithUserBase (Aws::String &&value)
 
LdapServerMetadataOutputWithUserBase (const char *value)
 
const Aws::StringGetUserRoleName () const
 
bool UserRoleNameHasBeenSet () const
 
void SetUserRoleName (const Aws::String &value)
 
void SetUserRoleName (Aws::String &&value)
 
void SetUserRoleName (const char *value)
 
LdapServerMetadataOutputWithUserRoleName (const Aws::String &value)
 
LdapServerMetadataOutputWithUserRoleName (Aws::String &&value)
 
LdapServerMetadataOutputWithUserRoleName (const char *value)
 
const Aws::StringGetUserSearchMatching () const
 
bool UserSearchMatchingHasBeenSet () const
 
void SetUserSearchMatching (const Aws::String &value)
 
void SetUserSearchMatching (Aws::String &&value)
 
void SetUserSearchMatching (const char *value)
 
LdapServerMetadataOutputWithUserSearchMatching (const Aws::String &value)
 
LdapServerMetadataOutputWithUserSearchMatching (Aws::String &&value)
 
LdapServerMetadataOutputWithUserSearchMatching (const char *value)
 
bool GetUserSearchSubtree () const
 
bool UserSearchSubtreeHasBeenSet () const
 
void SetUserSearchSubtree (bool value)
 
LdapServerMetadataOutputWithUserSearchSubtree (bool value)
 

Detailed Description

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

See Also:

AWS API Reference

Definition at line 33 of file LdapServerMetadataOutput.h.

Constructor & Destructor Documentation

◆ LdapServerMetadataOutput() [1/2]

Aws::MQ::Model::LdapServerMetadataOutput::LdapServerMetadataOutput ( )

◆ LdapServerMetadataOutput() [2/2]

Aws::MQ::Model::LdapServerMetadataOutput::LdapServerMetadataOutput ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddHosts() [1/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::AddHosts ( Aws::String &&  value)
inline

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

Definition at line 88 of file LdapServerMetadataOutput.h.

◆ AddHosts() [2/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::AddHosts ( const Aws::String value)
inline

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

Definition at line 82 of file LdapServerMetadataOutput.h.

◆ AddHosts() [3/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::AddHosts ( const char *  value)
inline

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

Definition at line 94 of file LdapServerMetadataOutput.h.

◆ GetHosts()

const Aws::Vector<Aws::String>& Aws::MQ::Model::LdapServerMetadataOutput::GetHosts ( ) const
inline

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

Definition at line 46 of file LdapServerMetadataOutput.h.

◆ GetRoleBase()

const Aws::String& Aws::MQ::Model::LdapServerMetadataOutput::GetRoleBase ( ) const
inline

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.</p>

Definition at line 103 of file LdapServerMetadataOutput.h.

◆ GetRoleName()

const Aws::String& Aws::MQ::Model::LdapServerMetadataOutput::GetRoleName ( ) const
inline

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

Definition at line 166 of file LdapServerMetadataOutput.h.

◆ GetRoleSearchMatching()

const Aws::String& Aws::MQ::Model::LdapServerMetadataOutput::GetRoleSearchMatching ( ) const
inline

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.

Definition at line 221 of file LdapServerMetadataOutput.h.

◆ GetRoleSearchSubtree()

bool Aws::MQ::Model::LdapServerMetadataOutput::GetRoleSearchSubtree ( ) const
inline

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

Definition at line 312 of file LdapServerMetadataOutput.h.

◆ GetServiceAccountUsername()

const Aws::String& Aws::MQ::Model::LdapServerMetadataOutput::GetServiceAccountUsername ( ) const
inline

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.

Definition at line 339 of file LdapServerMetadataOutput.h.

◆ GetUserBase()

const Aws::String& Aws::MQ::Model::LdapServerMetadataOutput::GetUserBase ( ) const
inline

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.

Definition at line 407 of file LdapServerMetadataOutput.h.

◆ GetUserRoleName()

const Aws::String& Aws::MQ::Model::LdapServerMetadataOutput::GetUserRoleName ( ) const
inline

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

Definition at line 490 of file LdapServerMetadataOutput.h.

◆ GetUserSearchMatching()

const Aws::String& Aws::MQ::Model::LdapServerMetadataOutput::GetUserSearchMatching ( ) const
inline

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.

Definition at line 537 of file LdapServerMetadataOutput.h.

◆ GetUserSearchSubtree()

bool Aws::MQ::Model::LdapServerMetadataOutput::GetUserSearchSubtree ( ) const
inline

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

Definition at line 621 of file LdapServerMetadataOutput.h.

◆ HostsHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataOutput::HostsHasBeenSet ( ) const
inline

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

Definition at line 52 of file LdapServerMetadataOutput.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MQ::Model::LdapServerMetadataOutput::Jsonize ( ) const

◆ operator=()

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleBaseHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataOutput::RoleBaseHasBeenSet ( ) const
inline

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.</p>

Definition at line 111 of file LdapServerMetadataOutput.h.

◆ RoleNameHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataOutput::RoleNameHasBeenSet ( ) const
inline

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

Definition at line 172 of file LdapServerMetadataOutput.h.

◆ RoleSearchMatchingHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataOutput::RoleSearchMatchingHasBeenSet ( ) const
inline

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.

Definition at line 233 of file LdapServerMetadataOutput.h.

◆ RoleSearchSubtreeHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataOutput::RoleSearchSubtreeHasBeenSet ( ) const
inline

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

Definition at line 318 of file LdapServerMetadataOutput.h.

◆ ServiceAccountUsernameHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataOutput::ServiceAccountUsernameHasBeenSet ( ) const
inline

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.

Definition at line 347 of file LdapServerMetadataOutput.h.

◆ SetHosts() [1/2]

void Aws::MQ::Model::LdapServerMetadataOutput::SetHosts ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 64 of file LdapServerMetadataOutput.h.

◆ SetHosts() [2/2]

void Aws::MQ::Model::LdapServerMetadataOutput::SetHosts ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 58 of file LdapServerMetadataOutput.h.

◆ SetRoleBase() [1/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetRoleBase ( Aws::String &&  value)
inline

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.</p>

Definition at line 127 of file LdapServerMetadataOutput.h.

◆ SetRoleBase() [2/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetRoleBase ( const Aws::String value)
inline

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.</p>

Definition at line 119 of file LdapServerMetadataOutput.h.

◆ SetRoleBase() [3/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetRoleBase ( const char *  value)
inline

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.</p>

Definition at line 135 of file LdapServerMetadataOutput.h.

◆ SetRoleName() [1/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetRoleName ( Aws::String &&  value)
inline

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

Definition at line 184 of file LdapServerMetadataOutput.h.

◆ SetRoleName() [2/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetRoleName ( const Aws::String value)
inline

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

Definition at line 178 of file LdapServerMetadataOutput.h.

◆ SetRoleName() [3/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetRoleName ( const char *  value)
inline

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

Definition at line 190 of file LdapServerMetadataOutput.h.

◆ SetRoleSearchMatching() [1/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetRoleSearchMatching ( Aws::String &&  value)
inline

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.

Definition at line 257 of file LdapServerMetadataOutput.h.

◆ SetRoleSearchMatching() [2/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetRoleSearchMatching ( const Aws::String value)
inline

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.

Definition at line 245 of file LdapServerMetadataOutput.h.

◆ SetRoleSearchMatching() [3/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetRoleSearchMatching ( const char *  value)
inline

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.

Definition at line 269 of file LdapServerMetadataOutput.h.

◆ SetRoleSearchSubtree()

void Aws::MQ::Model::LdapServerMetadataOutput::SetRoleSearchSubtree ( bool  value)
inline

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

Definition at line 324 of file LdapServerMetadataOutput.h.

◆ SetServiceAccountUsername() [1/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetServiceAccountUsername ( Aws::String &&  value)
inline

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.

Definition at line 363 of file LdapServerMetadataOutput.h.

◆ SetServiceAccountUsername() [2/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetServiceAccountUsername ( const Aws::String value)
inline

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.

Definition at line 355 of file LdapServerMetadataOutput.h.

◆ SetServiceAccountUsername() [3/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetServiceAccountUsername ( const char *  value)
inline

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.

Definition at line 371 of file LdapServerMetadataOutput.h.

◆ SetUserBase() [1/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetUserBase ( Aws::String &&  value)
inline

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.

Definition at line 440 of file LdapServerMetadataOutput.h.

◆ SetUserBase() [2/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetUserBase ( const Aws::String value)
inline

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.

Definition at line 429 of file LdapServerMetadataOutput.h.

◆ SetUserBase() [3/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetUserBase ( const char *  value)
inline

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.

Definition at line 451 of file LdapServerMetadataOutput.h.

◆ SetUserRoleName() [1/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetUserRoleName ( Aws::String &&  value)
inline

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

Definition at line 505 of file LdapServerMetadataOutput.h.

◆ SetUserRoleName() [2/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetUserRoleName ( const Aws::String value)
inline

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

Definition at line 500 of file LdapServerMetadataOutput.h.

◆ SetUserRoleName() [3/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetUserRoleName ( const char *  value)
inline

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

Definition at line 510 of file LdapServerMetadataOutput.h.

◆ SetUserSearchMatching() [1/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetUserSearchMatching ( Aws::String &&  value)
inline

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.

Definition at line 570 of file LdapServerMetadataOutput.h.

◆ SetUserSearchMatching() [2/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetUserSearchMatching ( const Aws::String value)
inline

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.

Definition at line 559 of file LdapServerMetadataOutput.h.

◆ SetUserSearchMatching() [3/3]

void Aws::MQ::Model::LdapServerMetadataOutput::SetUserSearchMatching ( const char *  value)
inline

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.

Definition at line 581 of file LdapServerMetadataOutput.h.

◆ SetUserSearchSubtree()

void Aws::MQ::Model::LdapServerMetadataOutput::SetUserSearchSubtree ( bool  value)
inline

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

Definition at line 633 of file LdapServerMetadataOutput.h.

◆ UserBaseHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataOutput::UserBaseHasBeenSet ( ) const
inline

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.

Definition at line 418 of file LdapServerMetadataOutput.h.

◆ UserRoleNameHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataOutput::UserRoleNameHasBeenSet ( ) const
inline

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

Definition at line 495 of file LdapServerMetadataOutput.h.

◆ UserSearchMatchingHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataOutput::UserSearchMatchingHasBeenSet ( ) const
inline

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.

Definition at line 548 of file LdapServerMetadataOutput.h.

◆ UserSearchSubtreeHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataOutput::UserSearchSubtreeHasBeenSet ( ) const
inline

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

Definition at line 627 of file LdapServerMetadataOutput.h.

◆ WithHosts() [1/2]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithHosts ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 76 of file LdapServerMetadataOutput.h.

◆ WithHosts() [2/2]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithHosts ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 70 of file LdapServerMetadataOutput.h.

◆ WithRoleBase() [1/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithRoleBase ( Aws::String &&  value)
inline

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.</p>

Definition at line 151 of file LdapServerMetadataOutput.h.

◆ WithRoleBase() [2/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithRoleBase ( const Aws::String value)
inline

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.</p>

Definition at line 143 of file LdapServerMetadataOutput.h.

◆ WithRoleBase() [3/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithRoleBase ( const char *  value)
inline

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.</p>

Definition at line 159 of file LdapServerMetadataOutput.h.

◆ WithRoleName() [1/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithRoleName ( Aws::String &&  value)
inline

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

Definition at line 202 of file LdapServerMetadataOutput.h.

◆ WithRoleName() [2/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithRoleName ( const Aws::String value)
inline

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

Definition at line 196 of file LdapServerMetadataOutput.h.

◆ WithRoleName() [3/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithRoleName ( const char *  value)
inline

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

Definition at line 208 of file LdapServerMetadataOutput.h.

◆ WithRoleSearchMatching() [1/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithRoleSearchMatching ( Aws::String &&  value)
inline

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.

Definition at line 293 of file LdapServerMetadataOutput.h.

◆ WithRoleSearchMatching() [2/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithRoleSearchMatching ( const Aws::String value)
inline

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.

Definition at line 281 of file LdapServerMetadataOutput.h.

◆ WithRoleSearchMatching() [3/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithRoleSearchMatching ( const char *  value)
inline

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.

Definition at line 305 of file LdapServerMetadataOutput.h.

◆ WithRoleSearchSubtree()

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithRoleSearchSubtree ( bool  value)
inline

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

Definition at line 330 of file LdapServerMetadataOutput.h.

◆ WithServiceAccountUsername() [1/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithServiceAccountUsername ( Aws::String &&  value)
inline

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.

Definition at line 387 of file LdapServerMetadataOutput.h.

◆ WithServiceAccountUsername() [2/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithServiceAccountUsername ( const Aws::String value)
inline

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.

Definition at line 379 of file LdapServerMetadataOutput.h.

◆ WithServiceAccountUsername() [3/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithServiceAccountUsername ( const char *  value)
inline

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.

Definition at line 395 of file LdapServerMetadataOutput.h.

◆ WithUserBase() [1/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithUserBase ( Aws::String &&  value)
inline

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.

Definition at line 473 of file LdapServerMetadataOutput.h.

◆ WithUserBase() [2/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithUserBase ( const Aws::String value)
inline

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.

Definition at line 462 of file LdapServerMetadataOutput.h.

◆ WithUserBase() [3/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithUserBase ( const char *  value)
inline

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.

Definition at line 484 of file LdapServerMetadataOutput.h.

◆ WithUserRoleName() [1/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithUserRoleName ( Aws::String &&  value)
inline

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

Definition at line 520 of file LdapServerMetadataOutput.h.

◆ WithUserRoleName() [2/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithUserRoleName ( const Aws::String value)
inline

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

Definition at line 515 of file LdapServerMetadataOutput.h.

◆ WithUserRoleName() [3/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithUserRoleName ( const char *  value)
inline

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

Definition at line 525 of file LdapServerMetadataOutput.h.

◆ WithUserSearchMatching() [1/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithUserSearchMatching ( Aws::String &&  value)
inline

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.

Definition at line 603 of file LdapServerMetadataOutput.h.

◆ WithUserSearchMatching() [2/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithUserSearchMatching ( const Aws::String value)
inline

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.

Definition at line 592 of file LdapServerMetadataOutput.h.

◆ WithUserSearchMatching() [3/3]

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithUserSearchMatching ( const char *  value)
inline

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.

Definition at line 614 of file LdapServerMetadataOutput.h.

◆ WithUserSearchSubtree()

LdapServerMetadataOutput& Aws::MQ::Model::LdapServerMetadataOutput::WithUserSearchSubtree ( bool  value)
inline

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

Definition at line 639 of file LdapServerMetadataOutput.h.


The documentation for this class was generated from the following file: