Class CfnBroker.LdapServerMetadataProperty
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AmazonMQ
Assembly: Amazon.CDK.AWS.AmazonMQ.dll
Syntax (csharp)
public class LdapServerMetadataProperty : Object, CfnBroker.ILdapServerMetadataPropertySyntax (vb)
Public Class LdapServerMetadataProperty
Inherits Object
Implements CfnBroker.ILdapServerMetadataPropertyRemarks
Does not apply to RabbitMQ brokers.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AmazonMQ;
var ldapServerMetadataProperty = new LdapServerMetadataProperty {
Hosts = new [] { "hosts" },
RoleBase = "roleBase",
RoleSearchMatching = "roleSearchMatching",
ServiceAccountPassword = "serviceAccountPassword",
ServiceAccountUsername = "serviceAccountUsername",
UserBase = "userBase",
UserSearchMatching = "userSearchMatching",
// the properties below are optional
RoleName = "roleName",
RoleSearchSubtree = false,
UserRoleName = "userRoleName",
UserSearchSubtree = false
};Synopsis
Constructors
| LdapServerMetadataProperty() |
Properties
| Hosts | Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . |
| RoleBase | The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. |
| RoleName | The group name attribute in a role entry whose value is the name of that role. |
| RoleSearchMatching | The LDAP search filter used to find roles within the roleBase. |
| RoleSearchSubtree | The directory search scope for the role. |
| ServiceAccountPassword | Service account password. |
| ServiceAccountUsername | Service account username. |
| UserBase | Select a particular subtree of the directory information tree (DIT) to search for user entries. |
| UserRoleName | The name of the LDAP attribute in the user's directory entry for the user's group membership. |
| UserSearchMatching | The LDAP search filter used to find users within the |
| UserSearchSubtree | The directory search scope for the user. |
Constructors
LdapServerMetadataProperty()
public LdapServerMetadataProperty()Properties
Hosts
Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory .
public string[] Hosts { get; set; }Property Value
System.String[]
Remarks
RoleBase
The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
public string RoleBase { get; set; }Property Value
System.String
Remarks
For example, ou=group , ou=corp , dc=corp , dc=example , dc=com .
RoleName
The group name attribute in a role entry whose value is the name of that role.
public string RoleName { get; set; }Property Value
System.String
Remarks
For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of.
RoleSearchMatching
The LDAP search filter used to find roles within the roleBase.
public string RoleSearchMatching { get; set; }Property Value
System.String
Remarks
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 RoleBases .
RoleSearchSubtree
The directory search scope for the role.
public object RoleSearchSubtree { get; set; }Property Value
System.Object
Remarks
If set to true, scope is to search the entire subtree.
ServiceAccountPassword
Service account password.
public string ServiceAccountPassword { get; set; }Property Value
System.String
Remarks
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 .
ServiceAccountUsername
Service account username.
public string ServiceAccountUsername { get; set; }Property Value
System.String
Remarks
A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , ou=corp , dc=corp , dc=example , dc=com .
UserBase
Select a particular subtree of the directory information tree (DIT) to search for user entries.
public string UserBase { get; set; }Property Value
System.String
Remarks
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 .
UserRoleName
The name of the LDAP attribute in the user's directory entry for the user's group membership.
public string UserRoleName { get; set; }Property Value
System.String
Remarks
In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute.
UserSearchMatching
The LDAP search filter used to find users within the userBase .
public string UserSearchMatching { get; set; }Property Value
System.String
Remarks
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 .
UserSearchSubtree
The directory search scope for the user.
public object UserSearchSubtree { get; set; }Property Value
System.Object
Remarks
If set to true, scope is to search the entire subtree.