Package software.amazon.awscdk.services.amazonmq

Class CfnBroker.LdapServerMetadataProperty.Builder

java.lang.Object

software.amazon.awscdk.services.amazonmq.CfnBroker.LdapServerMetadataProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBroker.LdapServerMetadataProperty>

Enclosing interface:

CfnBroker.LdapServerMetadataProperty

@Stability(Stable)
public static final class CfnBroker.LdapServerMetadataProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnBroker.LdapServerMetadataProperty>

A builder for CfnBroker.LdapServerMetadataProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnBroker.LdapServerMetadataProperty	build()	Builds the configured instance.
CfnBroker.LdapServerMetadataProperty.Builder	hosts(List<String> hosts)	Sets the value of CfnBroker.LdapServerMetadataProperty.getHosts()
CfnBroker.LdapServerMetadataProperty.Builder	roleBase(String roleBase)	Sets the value of CfnBroker.LdapServerMetadataProperty.getRoleBase()
CfnBroker.LdapServerMetadataProperty.Builder	roleName(String roleName)	Sets the value of CfnBroker.LdapServerMetadataProperty.getRoleName()
CfnBroker.LdapServerMetadataProperty.Builder	roleSearchMatching(String roleSearchMatching)	Sets the value of CfnBroker.LdapServerMetadataProperty.getRoleSearchMatching()
CfnBroker.LdapServerMetadataProperty.Builder	roleSearchSubtree(Boolean roleSearchSubtree)	Sets the value of CfnBroker.LdapServerMetadataProperty.getRoleSearchSubtree()
CfnBroker.LdapServerMetadataProperty.Builder	roleSearchSubtree(IResolvable roleSearchSubtree)	Sets the value of CfnBroker.LdapServerMetadataProperty.getRoleSearchSubtree()
CfnBroker.LdapServerMetadataProperty.Builder	serviceAccountPassword(String serviceAccountPassword)	Sets the value of CfnBroker.LdapServerMetadataProperty.getServiceAccountPassword()
CfnBroker.LdapServerMetadataProperty.Builder	serviceAccountUsername(String serviceAccountUsername)	Sets the value of CfnBroker.LdapServerMetadataProperty.getServiceAccountUsername()
CfnBroker.LdapServerMetadataProperty.Builder	userBase(String userBase)	Sets the value of CfnBroker.LdapServerMetadataProperty.getUserBase()
CfnBroker.LdapServerMetadataProperty.Builder	userRoleName(String userRoleName)	Sets the value of CfnBroker.LdapServerMetadataProperty.getUserRoleName()
CfnBroker.LdapServerMetadataProperty.Builder	userSearchMatching(String userSearchMatching)	Sets the value of CfnBroker.LdapServerMetadataProperty.getUserSearchMatching()
CfnBroker.LdapServerMetadataProperty.Builder	userSearchSubtree(Boolean userSearchSubtree)	Sets the value of CfnBroker.LdapServerMetadataProperty.getUserSearchSubtree()
CfnBroker.LdapServerMetadataProperty.Builder	userSearchSubtree(IResolvable userSearchSubtree)	Sets the value of CfnBroker.LdapServerMetadataProperty.getUserSearchSubtree()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

hosts

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty.Builder hosts(List<String> hosts)

Sets the value of CfnBroker.LdapServerMetadataProperty.getHosts()

Parameters:

hosts - Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . This parameter is required. Optional failover server.

Returns:

this

roleBase

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty.Builder roleBase(String roleBase)

Sets the value of CfnBroker.LdapServerMetadataProperty.getRoleBase()

Parameters:

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

Returns:

this

roleSearchMatching

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty.Builder roleSearchMatching(String roleSearchMatching)

Sets the value of CfnBroker.LdapServerMetadataProperty.getRoleSearchMatching()

Parameters:

roleSearchMatching - The LDAP search filter used to find roles within the roleBase. This parameter is required. 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 .

Returns:

this

serviceAccountPassword

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty.Builder serviceAccountPassword(String serviceAccountPassword)

Sets the value of CfnBroker.LdapServerMetadataProperty.getServiceAccountPassword()

Parameters:

serviceAccountPassword - Service account password. This parameter is required. 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:

this

serviceAccountUsername

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty.Builder serviceAccountUsername(String serviceAccountUsername)

Sets the value of CfnBroker.LdapServerMetadataProperty.getServiceAccountUsername()

Parameters:

serviceAccountUsername - Service account username. This parameter is required. 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 .

Returns:

this

userBase

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty.Builder userBase(String userBase)

Sets the value of CfnBroker.LdapServerMetadataProperty.getUserBase()

Parameters:

userBase - Select a particular subtree of the directory information tree (DIT) to search for user entries. This parameter is required. 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:

this

userSearchMatching

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty.Builder userSearchMatching(String userSearchMatching)

Sets the value of CfnBroker.LdapServerMetadataProperty.getUserSearchMatching()

Parameters:

userSearchMatching - The LDAP search filter used to find users within the userBase . This parameter is required. 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:

this

roleName

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty.Builder roleName(String roleName)

Sets the value of CfnBroker.LdapServerMetadataProperty.getRoleName()

Parameters:

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

Returns:

this

roleSearchSubtree

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty.Builder roleSearchSubtree(Boolean roleSearchSubtree)

Sets the value of CfnBroker.LdapServerMetadataProperty.getRoleSearchSubtree()

Parameters:

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

Returns:

this

roleSearchSubtree

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty.Builder roleSearchSubtree(IResolvable roleSearchSubtree)

Sets the value of CfnBroker.LdapServerMetadataProperty.getRoleSearchSubtree()

Parameters:

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

Returns:

this

userRoleName

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty.Builder userRoleName(String userRoleName)

Sets the value of CfnBroker.LdapServerMetadataProperty.getUserRoleName()

Parameters:

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

Returns:

this

userSearchSubtree

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty.Builder userSearchSubtree(Boolean userSearchSubtree)

Sets the value of CfnBroker.LdapServerMetadataProperty.getUserSearchSubtree()

Parameters:

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

Returns:

this

userSearchSubtree

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty.Builder userSearchSubtree(IResolvable userSearchSubtree)

Sets the value of CfnBroker.LdapServerMetadataProperty.getUserSearchSubtree()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnBroker.LdapServerMetadataProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnBroker.LdapServerMetadataProperty>

Returns:

a new instance of CfnBroker.LdapServerMetadataProperty

Throws:

NullPointerException - if any required attribute was not provided