com.amazonaws.services.connect.model

Class CreateUserRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.CreateUserRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateUserRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateUserRequest()

Method Summary

Modifier and Type	Method and Description
CreateUserRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateUserRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateUserRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDirectoryUserId() The identifier of the user account in the directory used for identity management.
String	getHierarchyGroupId() The identifier of the hierarchy group for the user.
UserIdentityInfo	getIdentityInfo() The information about the identity of the user.
String	getInstanceId() The identifier of the Amazon Connect instance.
String	getPassword() The password for the user account.
UserPhoneConfig	getPhoneConfig() The phone settings for the user.
String	getRoutingProfileId() The identifier of the routing profile for the user.
List<String>	getSecurityProfileIds() The identifier of the security profile for the user.
Map<String,String>	getTags() The tags used to organize, track, or control access for this resource.
String	getUsername() The user name for the account.
int	hashCode()
void	setDirectoryUserId(String directoryUserId) The identifier of the user account in the directory used for identity management.
void	setHierarchyGroupId(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(String instanceId) The identifier of the Amazon Connect instance.
void	setPassword(String password) The password for the user account.
void	setPhoneConfig(UserPhoneConfig phoneConfig) The phone settings for the user.
void	setRoutingProfileId(String routingProfileId) The identifier of the routing profile for the user.
void	setSecurityProfileIds(Collection<String> securityProfileIds) The identifier of the security profile for the user.
void	setTags(Map<String,String> tags) The tags used to organize, track, or control access for this resource.
void	setUsername(String username) The user name for the account.
String	toString() Returns a string representation of this object.
CreateUserRequest	withDirectoryUserId(String directoryUserId) The identifier of the user account in the directory used for identity management.
CreateUserRequest	withHierarchyGroupId(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(String instanceId) The identifier of the Amazon Connect instance.
CreateUserRequest	withPassword(String password) The password for the user account.
CreateUserRequest	withPhoneConfig(UserPhoneConfig phoneConfig) The phone settings for the user.
CreateUserRequest	withRoutingProfileId(String routingProfileId) The identifier of the routing profile for the user.
CreateUserRequest	withSecurityProfileIds(Collection<String> securityProfileIds) The identifier of the security profile for the user.
CreateUserRequest	withSecurityProfileIds(String... securityProfileIds) The identifier of the security profile for the user.
CreateUserRequest	withTags(Map<String,String> tags) The tags used to organize, track, or control access for this resource.
CreateUserRequest	withUsername(String username) The user name for the account.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateUserRequest

public CreateUserRequest()

Method Detail

setUsername

public void setUsername(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_-.\@]+.

Username can include @ only if used in an email format. For example:

• Correct: testuser

• Correct: testuser@example.com

• Incorrect: testuser@example

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_-.\@]+.

Username can include @ only if used in an email format. For example:

• Correct: testuser

• Correct: testuser@example.com

• Incorrect: testuser@example

getUsername

public 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_-.\@]+.

Username can include @ only if used in an email format. For example:

• Correct: testuser

• Correct: testuser@example.com

• Incorrect: testuser@example

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_-.\@]+.

Username can include @ only if used in an email format. For example:

• Correct: testuser

• Correct: testuser@example.com

• Incorrect: testuser@example

withUsername

public CreateUserRequest withUsername(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_-.\@]+.

Username can include @ only if used in an email format. For example:

• Correct: testuser

• Correct: testuser@example.com

• Incorrect: testuser@example

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_-.\@]+.

Username can include @ only if used in an email format. For example:

• Correct: testuser

• Correct: testuser@example.com

• Incorrect: testuser@example

Returns:

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

setPassword

public void setPassword(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.

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.

getPassword

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

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.

withPassword

public CreateUserRequest withPassword(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.

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:

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

setIdentityInfo

public void setIdentityInfo(UserIdentityInfo identityInfo)

The information about the identity of the user.

Parameters:

identityInfo - The information about the identity of the user.

getIdentityInfo

public UserIdentityInfo getIdentityInfo()

The information about the identity of the user.

Returns:

The information about the identity of the user.

withIdentityInfo

public CreateUserRequest withIdentityInfo(UserIdentityInfo identityInfo)

The information about the identity of the user.

Parameters:

identityInfo - The information about the identity of the user.

Returns:

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

setPhoneConfig

public void setPhoneConfig(UserPhoneConfig phoneConfig)

The phone settings for the user.

Parameters:

phoneConfig - The phone settings for the user.

getPhoneConfig

public UserPhoneConfig getPhoneConfig()

The phone settings for the user.

Returns:

The phone settings for the user.

withPhoneConfig

public CreateUserRequest withPhoneConfig(UserPhoneConfig phoneConfig)

The phone settings for the user.

Parameters:

phoneConfig - The phone settings for the user.

Returns:

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

setDirectoryUserId

public void setDirectoryUserId(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.

getDirectoryUserId

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

withDirectoryUserId

public CreateUserRequest withDirectoryUserId(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.

Returns:

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

getSecurityProfileIds

public List<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(Collection<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(String... securityProfileIds)

The identifier of the security profile for the user.

NOTE: This method appends the values to the existing list (if any). Use setSecurityProfileIds(java.util.Collection) or withSecurityProfileIds(java.util.Collection) if you want to override the existing values.

Parameters:

securityProfileIds - The identifier of the security profile for the user.

Returns:

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

withSecurityProfileIds

public CreateUserRequest withSecurityProfileIds(Collection<String> securityProfileIds)

The identifier of the security profile for the user.

Parameters:

securityProfileIds - The identifier of the security profile for the user.

Returns:

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

setRoutingProfileId

public void setRoutingProfileId(String routingProfileId)

The identifier of the routing profile for the user.

Parameters:

routingProfileId - The identifier of the routing profile for the user.

getRoutingProfileId

public String getRoutingProfileId()

The identifier of the routing profile for the user.

Returns:

The identifier of the routing profile for the user.

withRoutingProfileId

public CreateUserRequest withRoutingProfileId(String routingProfileId)

The identifier of the routing profile for the user.

Parameters:

routingProfileId - The identifier of the routing profile for the user.

Returns:

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

setHierarchyGroupId

public void setHierarchyGroupId(String hierarchyGroupId)

The identifier of the hierarchy group for the user.

Parameters:

hierarchyGroupId - The identifier of the hierarchy group for the user.

getHierarchyGroupId

public String getHierarchyGroupId()

The identifier of the hierarchy group for the user.

Returns:

The identifier of the hierarchy group for the user.

withHierarchyGroupId

public CreateUserRequest withHierarchyGroupId(String hierarchyGroupId)

The identifier of the hierarchy group for the user.

Parameters:

hierarchyGroupId - The identifier of the hierarchy group for the user.

Returns:

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

setInstanceId

public void setInstanceId(String instanceId)

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Parameters:

instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

getInstanceId

public String getInstanceId()

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

withInstanceId

public CreateUserRequest withInstanceId(String instanceId)

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Parameters:

instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

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

getTags

public Map<String,String> getTags()

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Returns:

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

setTags

public void setTags(Map<String,String> tags)

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Parameters:

tags - The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

withTags

public CreateUserRequest withTags(Map<String,String> tags)

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Parameters:

tags - The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Returns:

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

addTagsEntry

public CreateUserRequest addTagsEntry(String key,
                                      String value)

Add a single Tags entry

See Also:

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

clearTagsEntries

public CreateUserRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateUserRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()