com.amazonaws.services.connect.model

Class CreateUserRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.CreateUserRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateUserRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateUserRequest()

Method Summary

Modifier and Type	Method and Description
CreateUserRequest	addTagsEntry(java.lang.String key, java.lang.String value) One or more tags.
CreateUserRequest	clearTagsEntries() Removes all the entries added into Tags.
boolean	equals(java.lang.Object obj)
java.lang.String	getDirectoryUserId() The identifier of the user account in the directory used for identity management.
java.lang.String	getHierarchyGroupId() The identifier of the hierarchy group for the user.
UserIdentityInfo	getIdentityInfo() The information about the identity of the user.
java.lang.String	getInstanceId() The identifier of the Amazon Connect instance.
java.lang.String	getPassword() The password for the user account.
UserPhoneConfig	getPhoneConfig() The phone settings for the user.
java.lang.String	getRoutingProfileId() The identifier of the routing profile for the user.
java.util.List<java.lang.String>	getSecurityProfileIds() The identifier of the security profile for the user.
java.util.Map<java.lang.String,java.lang.String>	getTags() One or more tags.
java.lang.String	getUsername() The user name for the account.
int	hashCode()
void	setDirectoryUserId(java.lang.String directoryUserId) The identifier of the user account in the directory used for identity management.
void	setHierarchyGroupId(java.lang.String hierarchyGroupId) The identifier of the hierarchy group for the user.
void	setIdentityInfo(UserIdentityInfo identityInfo) The information about the identity of the user.
void	setInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
void	setPassword(java.lang.String password) The password for the user account.
void	setPhoneConfig(UserPhoneConfig phoneConfig) The phone settings for the user.
void	setRoutingProfileId(java.lang.String routingProfileId) The identifier of the routing profile for the user.
void	setSecurityProfileIds(java.util.Collection<java.lang.String> securityProfileIds) The identifier of the security profile for the user.
void	setTags(java.util.Map<java.lang.String,java.lang.String> tags) One or more tags.
void	setUsername(java.lang.String username) The user name for the account.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateUserRequest	withDirectoryUserId(java.lang.String directoryUserId) The identifier of the user account in the directory used for identity management.
CreateUserRequest	withHierarchyGroupId(java.lang.String hierarchyGroupId) The identifier of the hierarchy group for the user.
CreateUserRequest	withIdentityInfo(UserIdentityInfo identityInfo) The information about the identity of the user.
CreateUserRequest	withInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
CreateUserRequest	withPassword(java.lang.String password) The password for the user account.
CreateUserRequest	withPhoneConfig(UserPhoneConfig phoneConfig) The phone settings for the user.
CreateUserRequest	withRoutingProfileId(java.lang.String routingProfileId) The identifier of the routing profile for the user.
CreateUserRequest	withSecurityProfileIds(java.util.Collection<java.lang.String> securityProfileIds) The identifier of the security profile for the user.
CreateUserRequest	withSecurityProfileIds(java.lang.String... securityProfileIds) The identifier of the security profile for the user.
CreateUserRequest	withTags(java.util.Map<java.lang.String,java.lang.String> tags) One or more tags.
CreateUserRequest	withUsername(java.lang.String username) The user name for the account.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateUserRequest

public CreateUserRequest()

Method Detail

getUsername

public java.lang.String getUsername()

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

Constraints:
Length: 1 - 100

Returns:

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

setUsername

public void setUsername(java.lang.String username)

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

Constraints:
Length: 1 - 100

Parameters:

username -

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

withUsername

public CreateUserRequest withUsername(java.lang.String username)

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

username -

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

Returns:

A reference to this updated object so that method calls can be chained together.

getPassword

public java.lang.String getPassword()

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

Constraints:
Pattern: /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d\S]{8,64}$/

Returns:

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

setPassword

public void setPassword(java.lang.String password)

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

Constraints:
Pattern: /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d\S]{8,64}$/

Parameters:

password -

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

withPassword

public CreateUserRequest withPassword(java.lang.String password)

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d\S]{8,64}$/

Parameters:

password -

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

Returns:

A reference to this updated object so that method calls can be chained together.

getIdentityInfo

public UserIdentityInfo getIdentityInfo()

The information about the identity of the user.

Returns:

The information about the identity of the user.

setIdentityInfo

public void setIdentityInfo(UserIdentityInfo identityInfo)

The information about the identity of the user.

Parameters:

identityInfo -

The information about the identity of the user.

withIdentityInfo

public CreateUserRequest withIdentityInfo(UserIdentityInfo identityInfo)

The information about the identity of the user.

Returns a reference to this object so that method calls can be chained together.

Parameters:

identityInfo -

The information about the identity of the user.

Returns:

A reference to this updated object so that method calls can be chained together.

getPhoneConfig

public UserPhoneConfig getPhoneConfig()

The phone settings for the user.

Returns:

The phone settings for the user.

setPhoneConfig

public void setPhoneConfig(UserPhoneConfig phoneConfig)

The phone settings for the user.

Parameters:

phoneConfig -

The phone settings for the user.

withPhoneConfig

public CreateUserRequest withPhoneConfig(UserPhoneConfig phoneConfig)

The phone settings for the user.

Returns a reference to this object so that method calls can be chained together.

Parameters:

phoneConfig -

The phone settings for the user.

Returns:

A reference to this updated object so that method calls can be chained together.

getDirectoryUserId

public java.lang.String getDirectoryUserId()

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

Returns:

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

setDirectoryUserId

public void setDirectoryUserId(java.lang.String directoryUserId)

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

Parameters:

directoryUserId -

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

withDirectoryUserId

public CreateUserRequest withDirectoryUserId(java.lang.String directoryUserId)

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

Returns a reference to this object so that method calls can be chained together.

Parameters:

directoryUserId -

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

Returns:

A reference to this updated object so that method calls can be chained together.

getSecurityProfileIds

public java.util.List<java.lang.String> getSecurityProfileIds()

The identifier of the security profile for the user.

Returns:

The identifier of the security profile for the user.

setSecurityProfileIds

public void setSecurityProfileIds(java.util.Collection<java.lang.String> securityProfileIds)

The identifier of the security profile for the user.

Parameters:

securityProfileIds -

The identifier of the security profile for the user.

withSecurityProfileIds

public CreateUserRequest withSecurityProfileIds(java.lang.String... securityProfileIds)

The identifier of the security profile for the user.

Returns a reference to this object so that method calls can be chained together.

Parameters:

securityProfileIds -

The identifier of the security profile for the user.

Returns:

A reference to this updated object so that method calls can be chained together.

withSecurityProfileIds

public CreateUserRequest withSecurityProfileIds(java.util.Collection<java.lang.String> securityProfileIds)

The identifier of the security profile for the user.

Returns a reference to this object so that method calls can be chained together.

Parameters:

securityProfileIds -

The identifier of the security profile for the user.

Returns:

A reference to this updated object so that method calls can be chained together.

getRoutingProfileId

public java.lang.String getRoutingProfileId()

The identifier of the routing profile for the user.

Returns:

The identifier of the routing profile for the user.

setRoutingProfileId

public void setRoutingProfileId(java.lang.String routingProfileId)

The identifier of the routing profile for the user.

Parameters:

routingProfileId -

The identifier of the routing profile for the user.

withRoutingProfileId

public CreateUserRequest withRoutingProfileId(java.lang.String routingProfileId)

The identifier of the routing profile for the user.

Returns a reference to this object so that method calls can be chained together.

Parameters:

routingProfileId -

The identifier of the routing profile for the user.

Returns:

A reference to this updated object so that method calls can be chained together.

getHierarchyGroupId

public java.lang.String getHierarchyGroupId()

The identifier of the hierarchy group for the user.

Returns:

The identifier of the hierarchy group for the user.

setHierarchyGroupId

public void setHierarchyGroupId(java.lang.String hierarchyGroupId)

The identifier of the hierarchy group for the user.

Parameters:

hierarchyGroupId -

The identifier of the hierarchy group for the user.

withHierarchyGroupId

public CreateUserRequest withHierarchyGroupId(java.lang.String hierarchyGroupId)

The identifier of the hierarchy group for the user.

Returns a reference to this object so that method calls can be chained together.

Parameters:

hierarchyGroupId -

The identifier of the hierarchy group for the user.

Returns:

A reference to this updated object so that method calls can be chained together.

getInstanceId

public java.lang.String getInstanceId()

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

Returns:

The identifier of the Amazon Connect instance.

setInstanceId

public void setInstanceId(java.lang.String instanceId)

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

Parameters:

instanceId -

The identifier of the Amazon Connect instance.

withInstanceId

public CreateUserRequest withInstanceId(java.lang.String instanceId)

The identifier of the Amazon Connect instance.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

instanceId -

The identifier of the Amazon Connect instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getTags

public java.util.Map<java.lang.String,java.lang.String> getTags()

One or more tags.

Returns:

One or more tags.

setTags

public void setTags(java.util.Map<java.lang.String,java.lang.String> tags)

One or more tags.

Parameters:

tags -

One or more tags.

withTags

public CreateUserRequest withTags(java.util.Map<java.lang.String,java.lang.String> tags)

One or more tags.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tags -

One or more tags.

Returns:

A reference to this updated object so that method calls can be chained together.

addTagsEntry

public CreateUserRequest addTagsEntry(java.lang.String key,
                                      java.lang.String value)

One or more tags.

The method adds a new key-value pair into Tags parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Tags.

value - The corresponding value of the entry to be added into Tags.

Returns:

A reference to this updated object so that method calls can be chained together.

clearTagsEntries

public CreateUserRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns a reference to this object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object