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

#include <LdapServerMetadataInput.h>

Public Member Functions

 LdapServerMetadataInput ()
 
 LdapServerMetadataInput (Aws::Utils::Json::JsonView jsonValue)
 
LdapServerMetadataInputoperator= (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)
 
LdapServerMetadataInputWithHosts (const Aws::Vector< Aws::String > &value)
 
LdapServerMetadataInputWithHosts (Aws::Vector< Aws::String > &&value)
 
LdapServerMetadataInputAddHosts (const Aws::String &value)
 
LdapServerMetadataInputAddHosts (Aws::String &&value)
 
LdapServerMetadataInputAddHosts (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)
 
LdapServerMetadataInputWithRoleBase (const Aws::String &value)
 
LdapServerMetadataInputWithRoleBase (Aws::String &&value)
 
LdapServerMetadataInputWithRoleBase (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)
 
LdapServerMetadataInputWithRoleName (const Aws::String &value)
 
LdapServerMetadataInputWithRoleName (Aws::String &&value)
 
LdapServerMetadataInputWithRoleName (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)
 
LdapServerMetadataInputWithRoleSearchMatching (const Aws::String &value)
 
LdapServerMetadataInputWithRoleSearchMatching (Aws::String &&value)
 
LdapServerMetadataInputWithRoleSearchMatching (const char *value)
 
bool GetRoleSearchSubtree () const
 
bool RoleSearchSubtreeHasBeenSet () const
 
void SetRoleSearchSubtree (bool value)
 
LdapServerMetadataInputWithRoleSearchSubtree (bool value)
 
const Aws::StringGetServiceAccountPassword () const
 
bool ServiceAccountPasswordHasBeenSet () const
 
void SetServiceAccountPassword (const Aws::String &value)
 
void SetServiceAccountPassword (Aws::String &&value)
 
void SetServiceAccountPassword (const char *value)
 
LdapServerMetadataInputWithServiceAccountPassword (const Aws::String &value)
 
LdapServerMetadataInputWithServiceAccountPassword (Aws::String &&value)
 
LdapServerMetadataInputWithServiceAccountPassword (const char *value)
 
const Aws::StringGetServiceAccountUsername () const
 
bool ServiceAccountUsernameHasBeenSet () const
 
void SetServiceAccountUsername (const Aws::String &value)
 
void SetServiceAccountUsername (Aws::String &&value)
 
void SetServiceAccountUsername (const char *value)
 
LdapServerMetadataInputWithServiceAccountUsername (const Aws::String &value)
 
LdapServerMetadataInputWithServiceAccountUsername (Aws::String &&value)
 
LdapServerMetadataInputWithServiceAccountUsername (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)
 
LdapServerMetadataInputWithUserBase (const Aws::String &value)
 
LdapServerMetadataInputWithUserBase (Aws::String &&value)
 
LdapServerMetadataInputWithUserBase (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)
 
LdapServerMetadataInputWithUserRoleName (const Aws::String &value)
 
LdapServerMetadataInputWithUserRoleName (Aws::String &&value)
 
LdapServerMetadataInputWithUserRoleName (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)
 
LdapServerMetadataInputWithUserSearchMatching (const Aws::String &value)
 
LdapServerMetadataInputWithUserSearchMatching (Aws::String &&value)
 
LdapServerMetadataInputWithUserSearchMatching (const char *value)
 
bool GetUserSearchSubtree () const
 
bool UserSearchSubtreeHasBeenSet () const
 
void SetUserSearchSubtree (bool value)
 
LdapServerMetadataInputWithUserSearchSubtree (bool value)
 

Detailed Description

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

Does not apply to RabbitMQ brokers.

See Also:

AWS API Reference

Definition at line 34 of file LdapServerMetadataInput.h.

Constructor & Destructor Documentation

◆ LdapServerMetadataInput() [1/2]

Aws::MQ::Model::LdapServerMetadataInput::LdapServerMetadataInput ( )

◆ LdapServerMetadataInput() [2/2]

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

Member Function Documentation

◆ AddHosts() [1/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 89 of file LdapServerMetadataInput.h.

◆ AddHosts() [2/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 83 of file LdapServerMetadataInput.h.

◆ AddHosts() [3/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 95 of file LdapServerMetadataInput.h.

◆ GetHosts()

const Aws::Vector<Aws::String>& Aws::MQ::Model::LdapServerMetadataInput::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 47 of file LdapServerMetadataInput.h.

◆ GetRoleBase()

const Aws::String& Aws::MQ::Model::LdapServerMetadataInput::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 104 of file LdapServerMetadataInput.h.

◆ GetRoleName()

const Aws::String& Aws::MQ::Model::LdapServerMetadataInput::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 167 of file LdapServerMetadataInput.h.

◆ GetRoleSearchMatching()

const Aws::String& Aws::MQ::Model::LdapServerMetadataInput::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 222 of file LdapServerMetadataInput.h.

◆ GetRoleSearchSubtree()

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

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

Definition at line 313 of file LdapServerMetadataInput.h.

◆ GetServiceAccountPassword()

const Aws::String& Aws::MQ::Model::LdapServerMetadataInput::GetServiceAccountPassword ( ) const
inline

Service account password. 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 340 of file LdapServerMetadataInput.h.

◆ GetServiceAccountUsername()

const Aws::String& Aws::MQ::Model::LdapServerMetadataInput::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 405 of file LdapServerMetadataInput.h.

◆ GetUserBase()

const Aws::String& Aws::MQ::Model::LdapServerMetadataInput::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 473 of file LdapServerMetadataInput.h.

◆ GetUserRoleName()

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

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

Definition at line 556 of file LdapServerMetadataInput.h.

◆ GetUserSearchMatching()

const Aws::String& Aws::MQ::Model::LdapServerMetadataInput::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 603 of file LdapServerMetadataInput.h.

◆ GetUserSearchSubtree()

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

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

Definition at line 687 of file LdapServerMetadataInput.h.

◆ HostsHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataInput::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 53 of file LdapServerMetadataInput.h.

◆ Jsonize()

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

◆ operator=()

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

◆ RoleBaseHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataInput::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 112 of file LdapServerMetadataInput.h.

◆ RoleNameHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataInput::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 173 of file LdapServerMetadataInput.h.

◆ RoleSearchMatchingHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataInput::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 234 of file LdapServerMetadataInput.h.

◆ RoleSearchSubtreeHasBeenSet()

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

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

Definition at line 319 of file LdapServerMetadataInput.h.

◆ ServiceAccountPasswordHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataInput::ServiceAccountPasswordHasBeenSet ( ) const
inline

Service account password. 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 348 of file LdapServerMetadataInput.h.

◆ ServiceAccountUsernameHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataInput::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 413 of file LdapServerMetadataInput.h.

◆ SetHosts() [1/2]

void Aws::MQ::Model::LdapServerMetadataInput::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 65 of file LdapServerMetadataInput.h.

◆ SetHosts() [2/2]

void Aws::MQ::Model::LdapServerMetadataInput::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 59 of file LdapServerMetadataInput.h.

◆ SetRoleBase() [1/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 128 of file LdapServerMetadataInput.h.

◆ SetRoleBase() [2/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 120 of file LdapServerMetadataInput.h.

◆ SetRoleBase() [3/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 136 of file LdapServerMetadataInput.h.

◆ SetRoleName() [1/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 185 of file LdapServerMetadataInput.h.

◆ SetRoleName() [2/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 179 of file LdapServerMetadataInput.h.

◆ SetRoleName() [3/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 191 of file LdapServerMetadataInput.h.

◆ SetRoleSearchMatching() [1/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 258 of file LdapServerMetadataInput.h.

◆ SetRoleSearchMatching() [2/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 246 of file LdapServerMetadataInput.h.

◆ SetRoleSearchMatching() [3/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 270 of file LdapServerMetadataInput.h.

◆ SetRoleSearchSubtree()

void Aws::MQ::Model::LdapServerMetadataInput::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 325 of file LdapServerMetadataInput.h.

◆ SetServiceAccountPassword() [1/3]

void Aws::MQ::Model::LdapServerMetadataInput::SetServiceAccountPassword ( Aws::String &&  value)
inline

Service account password. 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 364 of file LdapServerMetadataInput.h.

◆ SetServiceAccountPassword() [2/3]

void Aws::MQ::Model::LdapServerMetadataInput::SetServiceAccountPassword ( const Aws::String value)
inline

Service account password. 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 356 of file LdapServerMetadataInput.h.

◆ SetServiceAccountPassword() [3/3]

void Aws::MQ::Model::LdapServerMetadataInput::SetServiceAccountPassword ( const char *  value)
inline

Service account password. 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 372 of file LdapServerMetadataInput.h.

◆ SetServiceAccountUsername() [1/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 429 of file LdapServerMetadataInput.h.

◆ SetServiceAccountUsername() [2/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 421 of file LdapServerMetadataInput.h.

◆ SetServiceAccountUsername() [3/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 437 of file LdapServerMetadataInput.h.

◆ SetUserBase() [1/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 506 of file LdapServerMetadataInput.h.

◆ SetUserBase() [2/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 495 of file LdapServerMetadataInput.h.

◆ SetUserBase() [3/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 517 of file LdapServerMetadataInput.h.

◆ SetUserRoleName() [1/3]

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

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

Definition at line 571 of file LdapServerMetadataInput.h.

◆ SetUserRoleName() [2/3]

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

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

Definition at line 566 of file LdapServerMetadataInput.h.

◆ SetUserRoleName() [3/3]

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

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

Definition at line 576 of file LdapServerMetadataInput.h.

◆ SetUserSearchMatching() [1/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 636 of file LdapServerMetadataInput.h.

◆ SetUserSearchMatching() [2/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 625 of file LdapServerMetadataInput.h.

◆ SetUserSearchMatching() [3/3]

void Aws::MQ::Model::LdapServerMetadataInput::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 647 of file LdapServerMetadataInput.h.

◆ SetUserSearchSubtree()

void Aws::MQ::Model::LdapServerMetadataInput::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 699 of file LdapServerMetadataInput.h.

◆ UserBaseHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataInput::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 484 of file LdapServerMetadataInput.h.

◆ UserRoleNameHasBeenSet()

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

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

Definition at line 561 of file LdapServerMetadataInput.h.

◆ UserSearchMatchingHasBeenSet()

bool Aws::MQ::Model::LdapServerMetadataInput::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 614 of file LdapServerMetadataInput.h.

◆ UserSearchSubtreeHasBeenSet()

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

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

Definition at line 693 of file LdapServerMetadataInput.h.

◆ WithHosts() [1/2]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 77 of file LdapServerMetadataInput.h.

◆ WithHosts() [2/2]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 71 of file LdapServerMetadataInput.h.

◆ WithRoleBase() [1/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 152 of file LdapServerMetadataInput.h.

◆ WithRoleBase() [2/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 144 of file LdapServerMetadataInput.h.

◆ WithRoleBase() [3/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 160 of file LdapServerMetadataInput.h.

◆ WithRoleName() [1/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 203 of file LdapServerMetadataInput.h.

◆ WithRoleName() [2/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 197 of file LdapServerMetadataInput.h.

◆ WithRoleName() [3/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 209 of file LdapServerMetadataInput.h.

◆ WithRoleSearchMatching() [1/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 294 of file LdapServerMetadataInput.h.

◆ WithRoleSearchMatching() [2/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 282 of file LdapServerMetadataInput.h.

◆ WithRoleSearchMatching() [3/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 306 of file LdapServerMetadataInput.h.

◆ WithRoleSearchSubtree()

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 331 of file LdapServerMetadataInput.h.

◆ WithServiceAccountPassword() [1/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::WithServiceAccountPassword ( Aws::String &&  value)
inline

Service account password. 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 388 of file LdapServerMetadataInput.h.

◆ WithServiceAccountPassword() [2/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::WithServiceAccountPassword ( const Aws::String value)
inline

Service account password. 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 380 of file LdapServerMetadataInput.h.

◆ WithServiceAccountPassword() [3/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::WithServiceAccountPassword ( const char *  value)
inline

Service account password. 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 396 of file LdapServerMetadataInput.h.

◆ WithServiceAccountUsername() [1/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 453 of file LdapServerMetadataInput.h.

◆ WithServiceAccountUsername() [2/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 445 of file LdapServerMetadataInput.h.

◆ WithServiceAccountUsername() [3/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 461 of file LdapServerMetadataInput.h.

◆ WithUserBase() [1/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 539 of file LdapServerMetadataInput.h.

◆ WithUserBase() [2/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 528 of file LdapServerMetadataInput.h.

◆ WithUserBase() [3/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 550 of file LdapServerMetadataInput.h.

◆ WithUserRoleName() [1/3]

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

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

Definition at line 586 of file LdapServerMetadataInput.h.

◆ WithUserRoleName() [2/3]

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

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

Definition at line 581 of file LdapServerMetadataInput.h.

◆ WithUserRoleName() [3/3]

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

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

Definition at line 591 of file LdapServerMetadataInput.h.

◆ WithUserSearchMatching() [1/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 669 of file LdapServerMetadataInput.h.

◆ WithUserSearchMatching() [2/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 658 of file LdapServerMetadataInput.h.

◆ WithUserSearchMatching() [3/3]

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 680 of file LdapServerMetadataInput.h.

◆ WithUserSearchSubtree()

LdapServerMetadataInput& Aws::MQ::Model::LdapServerMetadataInput::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 705 of file LdapServerMetadataInput.h.


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