software.amazon.awscdk.services.amazonmq

Interface CfnBroker.LdapServerMetadataProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBroker.LdapServerMetadataProperty.Jsii$Proxy

Enclosing class:

CfnBroker

@Stability(value=Stable)
public static interface CfnBroker.LdapServerMetadataProperty
extends software.amazon.jsii.JsiiSerializable

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

Does not apply to RabbitMQ brokers.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amazonmq.*;
 LdapServerMetadataProperty ldapServerMetadataProperty = LdapServerMetadataProperty.builder()
         .hosts(List.of("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)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnBroker.LdapServerMetadataProperty.Builder A builder for CfnBroker.LdapServerMetadataProperty
static class	CfnBroker.LdapServerMetadataProperty.Jsii$Proxy An implementation for CfnBroker.LdapServerMetadataProperty

Method Summary

Modifier and Type	Method and Description
static CfnBroker.LdapServerMetadataProperty.Builder	builder()
List<String>	getHosts() Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory .
String	getRoleBase() The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
default String	getRoleName() The group name attribute in a role entry whose value is the name of that role.
String	getRoleSearchMatching() The LDAP search filter used to find roles within the roleBase.
default Object	getRoleSearchSubtree() The directory search scope for the role.
String	getServiceAccountPassword() Service account password.
String	getServiceAccountUsername() Service account username.
String	getUserBase() Select a particular subtree of the directory information tree (DIT) to search for user entries.
default String	getUserRoleName() The name of the LDAP attribute in the user's directory entry for the user's group membership.
String	getUserSearchMatching() The LDAP search filter used to find users within the `userBase` .
default Object	getUserSearchSubtree() The directory search scope for the user.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHosts

@Stability(value=Stable)
 @NotNull
List<String> getHosts()

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

Optional failover server.

getRoleBase

@Stability(value=Stable)
 @NotNull
String getRoleBase()

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 .

getRoleSearchMatching

@Stability(value=Stable)
 @NotNull
String getRoleSearchMatching()

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 RoleBases .

getServiceAccountPassword

@Stability(value=Stable)
 @NotNull
String getServiceAccountPassword()

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 .

getServiceAccountUsername

@Stability(value=Stable)
 @NotNull
String getServiceAccountUsername()

Service account username.

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 .

getUserBase

@Stability(value=Stable)
 @NotNull
String getUserBase()

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 .

getUserSearchMatching

@Stability(value=Stable)
 @NotNull
String getUserSearchMatching()

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 .

getRoleName

@Stability(value=Stable)
 @Nullable
default String getRoleName()

The group name attribute in a role entry whose value is the name of that role.

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.

getRoleSearchSubtree

@Stability(value=Stable)
 @Nullable
default Object getRoleSearchSubtree()

The directory search scope for the role.

If set to true, scope is to search the entire subtree.

getUserRoleName

@Stability(value=Stable)
 @Nullable
default String getUserRoleName()

The name of the LDAP attribute in the user's directory entry for the user's group membership.

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.

getUserSearchSubtree

@Stability(value=Stable)
 @Nullable
default Object getUserSearchSubtree()

The directory search scope for the user.

If set to true, scope is to search the entire subtree.

builder

@Stability(value=Stable)
static CfnBroker.LdapServerMetadataProperty.Builder builder()

Returns:

a CfnBroker.LdapServerMetadataProperty.Builder of CfnBroker.LdapServerMetadataProperty