Class: Aws::MQ::Types::LdapServerMetadataInput

Inherits:

Struct

• Object
• Struct
• Aws::MQ::Types::LdapServerMetadataInput

Defined in:

gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb

Overview

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 Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #hosts ⇒ Array<String>

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

• #role_base ⇒ String

  The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.

• #role_name ⇒ String

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

• #role_search_matching ⇒ String

  The LDAP search filter used to find roles within the roleBase.

• #role_search_subtree ⇒ Boolean

  The directory search scope for the role.

• #service_account_password ⇒ String

  Service account password.

• #service_account_username ⇒ String

  Service account username.

• #user_base ⇒ String

  Select a particular subtree of the directory information tree (DIT) to search for user entries.

• #user_role_name ⇒ String

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

• #user_search_matching ⇒ String

  The LDAP search filter used to find users within the userBase.

• #user_search_subtree ⇒ Boolean

  The directory search scope for the user.

Instance Attribute Details

#hosts ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1961

class LdapServerMetadataInput < Struct.new(
  :hosts,
  :role_base,
  :role_name,
  :role_search_matching,
  :role_search_subtree,
  :service_account_password,
  :service_account_username,
  :user_base,
  :user_role_name,
  :user_search_matching,
  :user_search_subtree)
  SENSITIVE = []
  include Aws::Structure
end

#role_base ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1961

class LdapServerMetadataInput < Struct.new(
  :hosts,
  :role_base,
  :role_name,
  :role_search_matching,
  :role_search_subtree,
  :service_account_password,
  :service_account_username,
  :user_base,
  :user_role_name,
  :user_search_matching,
  :user_search_subtree)
  SENSITIVE = []
  include Aws::Structure
end

#role_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1961

class LdapServerMetadataInput < Struct.new(
  :hosts,
  :role_base,
  :role_name,
  :role_search_matching,
  :role_search_subtree,
  :service_account_password,
  :service_account_username,
  :user_base,
  :user_role_name,
  :user_search_matching,
  :user_search_subtree)
  SENSITIVE = []
  include Aws::Structure
end

#role_search_matching ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1961

class LdapServerMetadataInput < Struct.new(
  :hosts,
  :role_base,
  :role_name,
  :role_search_matching,
  :role_search_subtree,
  :service_account_password,
  :service_account_username,
  :user_base,
  :user_role_name,
  :user_search_matching,
  :user_search_subtree)
  SENSITIVE = []
  include Aws::Structure
end

#role_search_subtree ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1961

class LdapServerMetadataInput < Struct.new(
  :hosts,
  :role_base,
  :role_name,
  :role_search_matching,
  :role_search_subtree,
  :service_account_password,
  :service_account_username,
  :user_base,
  :user_role_name,
  :user_search_matching,
  :user_search_subtree)
  SENSITIVE = []
  include Aws::Structure
end

#service_account_password ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1961

class LdapServerMetadataInput < Struct.new(
  :hosts,
  :role_base,
  :role_name,
  :role_search_matching,
  :role_search_subtree,
  :service_account_password,
  :service_account_username,
  :user_base,
  :user_role_name,
  :user_search_matching,
  :user_search_subtree)
  SENSITIVE = []
  include Aws::Structure
end

#service_account_username ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1961

class LdapServerMetadataInput < Struct.new(
  :hosts,
  :role_base,
  :role_name,
  :role_search_matching,
  :role_search_subtree,
  :service_account_password,
  :service_account_username,
  :user_base,
  :user_role_name,
  :user_search_matching,
  :user_search_subtree)
  SENSITIVE = []
  include Aws::Structure
end

#user_base ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1961

class LdapServerMetadataInput < Struct.new(
  :hosts,
  :role_base,
  :role_name,
  :role_search_matching,
  :role_search_subtree,
  :service_account_password,
  :service_account_username,
  :user_base,
  :user_role_name,
  :user_search_matching,
  :user_search_subtree)
  SENSITIVE = []
  include Aws::Structure
end

#user_role_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1961

class LdapServerMetadataInput < Struct.new(
  :hosts,
  :role_base,
  :role_name,
  :role_search_matching,
  :role_search_subtree,
  :service_account_password,
  :service_account_username,
  :user_base,
  :user_role_name,
  :user_search_matching,
  :user_search_subtree)
  SENSITIVE = []
  include Aws::Structure
end

#user_search_matching ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1961

class LdapServerMetadataInput < Struct.new(
  :hosts,
  :role_base,
  :role_name,
  :role_search_matching,
  :role_search_subtree,
  :service_account_password,
  :service_account_username,
  :user_base,
  :user_role_name,
  :user_search_matching,
  :user_search_subtree)
  SENSITIVE = []
  include Aws::Structure
end

#user_search_subtree ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1961

class LdapServerMetadataInput < Struct.new(
  :hosts,
  :role_base,
  :role_name,
  :role_search_matching,
  :role_search_subtree,
  :service_account_password,
  :service_account_username,
  :user_base,
  :user_role_name,
  :user_search_matching,
  :user_search_subtree)
  SENSITIVE = []
  include Aws::Structure
end