@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateUserRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateUserRequest() |
Modifier and Type | Method and Description |
---|---|
CreateUserRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getDirectoryUserId()
The unique identifier for the user account in the directory service directory used for identity management.
|
String |
getHierarchyGroupId()
The unique identifier for the hierarchy group to assign to the user created.
|
UserIdentityInfo |
getIdentityInfo()
Information about the user, including email address, first name, and last name.
|
String |
getInstanceId()
The identifier for your Amazon Connect instance.
|
String |
getPassword()
The password for the user account to create.
|
UserPhoneConfig |
getPhoneConfig()
Specifies the phone settings for the user, including
AfterContactWorkTimeLimit ,
AutoAccept , DeskPhoneNumber , and PhoneType . |
String |
getRoutingProfileId()
The unique identifier for the routing profile to assign to the user created.
|
List<String> |
getSecurityProfileIds()
The unique identifier of the security profile to assign to the user created.
|
String |
getUsername()
The user name in Amazon Connect for the account to create.
|
int |
hashCode() |
void |
setDirectoryUserId(String directoryUserId)
The unique identifier for the user account in the directory service directory used for identity management.
|
void |
setHierarchyGroupId(String hierarchyGroupId)
The unique identifier for the hierarchy group to assign to the user created.
|
void |
setIdentityInfo(UserIdentityInfo identityInfo)
Information about the user, including email address, first name, and last name.
|
void |
setInstanceId(String instanceId)
The identifier for your Amazon Connect instance.
|
void |
setPassword(String password)
The password for the user account to create.
|
void |
setPhoneConfig(UserPhoneConfig phoneConfig)
Specifies the phone settings for the user, including
AfterContactWorkTimeLimit ,
AutoAccept , DeskPhoneNumber , and PhoneType . |
void |
setRoutingProfileId(String routingProfileId)
The unique identifier for the routing profile to assign to the user created.
|
void |
setSecurityProfileIds(Collection<String> securityProfileIds)
The unique identifier of the security profile to assign to the user created.
|
void |
setUsername(String username)
The user name in Amazon Connect for the account to create.
|
String |
toString()
Returns a string representation of this object.
|
CreateUserRequest |
withDirectoryUserId(String directoryUserId)
The unique identifier for the user account in the directory service directory used for identity management.
|
CreateUserRequest |
withHierarchyGroupId(String hierarchyGroupId)
The unique identifier for the hierarchy group to assign to the user created.
|
CreateUserRequest |
withIdentityInfo(UserIdentityInfo identityInfo)
Information about the user, including email address, first name, and last name.
|
CreateUserRequest |
withInstanceId(String instanceId)
The identifier for your Amazon Connect instance.
|
CreateUserRequest |
withPassword(String password)
The password for the user account to create.
|
CreateUserRequest |
withPhoneConfig(UserPhoneConfig phoneConfig)
Specifies the phone settings for the user, including
AfterContactWorkTimeLimit ,
AutoAccept , DeskPhoneNumber , and PhoneType . |
CreateUserRequest |
withRoutingProfileId(String routingProfileId)
The unique identifier for the routing profile to assign to the user created.
|
CreateUserRequest |
withSecurityProfileIds(Collection<String> securityProfileIds)
The unique identifier of the security profile to assign to the user created.
|
CreateUserRequest |
withSecurityProfileIds(String... securityProfileIds)
The unique identifier of the security profile to assign to the user created.
|
CreateUserRequest |
withUsername(String username)
The user name in Amazon Connect for the account to create.
|
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
public void setUsername(String username)
The user name in Amazon Connect for the account to create. If you are using SAML for identity management in your
Amazon Connect, the value for Username
can include up to 64 characters from [a-zA-Z0-9_-.\@]+.
username
- The user name in Amazon Connect for the account to create. If you are using SAML for identity management
in your Amazon Connect, the value for Username
can include up to 64 characters from
[a-zA-Z0-9_-.\@]+.public String getUsername()
The user name in Amazon Connect for the account to create. If you are using SAML for identity management in your
Amazon Connect, the value for Username
can include up to 64 characters from [a-zA-Z0-9_-.\@]+.
Username
can include up to 64 characters from
[a-zA-Z0-9_-.\@]+.public CreateUserRequest withUsername(String username)
The user name in Amazon Connect for the account to create. If you are using SAML for identity management in your
Amazon Connect, the value for Username
can include up to 64 characters from [a-zA-Z0-9_-.\@]+.
username
- The user name in Amazon Connect for the account to create. If you are using SAML for identity management
in your Amazon Connect, the value for Username
can include up to 64 characters from
[a-zA-Z0-9_-.\@]+.public void setPassword(String password)
The password for the user account to create. This is required if you are using Amazon Connect for identity
management. If you are using SAML for identity management and include this parameter, an
InvalidRequestException
is returned.
password
- The password for the user account to create. This is required if you are using Amazon Connect for identity
management. If you are using SAML for identity management and include this parameter, an
InvalidRequestException
is returned.public String getPassword()
The password for the user account to create. This is required if you are using Amazon Connect for identity
management. If you are using SAML for identity management and include this parameter, an
InvalidRequestException
is returned.
InvalidRequestException
is returned.public CreateUserRequest withPassword(String password)
The password for the user account to create. This is required if you are using Amazon Connect for identity
management. If you are using SAML for identity management and include this parameter, an
InvalidRequestException
is returned.
password
- The password for the user account to create. This is required if you are using Amazon Connect for identity
management. If you are using SAML for identity management and include this parameter, an
InvalidRequestException
is returned.public void setIdentityInfo(UserIdentityInfo identityInfo)
Information about the user, including email address, first name, and last name.
identityInfo
- Information about the user, including email address, first name, and last name.public UserIdentityInfo getIdentityInfo()
Information about the user, including email address, first name, and last name.
public CreateUserRequest withIdentityInfo(UserIdentityInfo identityInfo)
Information about the user, including email address, first name, and last name.
identityInfo
- Information about the user, including email address, first name, and last name.public void setPhoneConfig(UserPhoneConfig phoneConfig)
Specifies the phone settings for the user, including AfterContactWorkTimeLimit
,
AutoAccept
, DeskPhoneNumber
, and PhoneType
.
phoneConfig
- Specifies the phone settings for the user, including AfterContactWorkTimeLimit
,
AutoAccept
, DeskPhoneNumber
, and PhoneType
.public UserPhoneConfig getPhoneConfig()
Specifies the phone settings for the user, including AfterContactWorkTimeLimit
,
AutoAccept
, DeskPhoneNumber
, and PhoneType
.
AfterContactWorkTimeLimit
,
AutoAccept
, DeskPhoneNumber
, and PhoneType
.public CreateUserRequest withPhoneConfig(UserPhoneConfig phoneConfig)
Specifies the phone settings for the user, including AfterContactWorkTimeLimit
,
AutoAccept
, DeskPhoneNumber
, and PhoneType
.
phoneConfig
- Specifies the phone settings for the user, including AfterContactWorkTimeLimit
,
AutoAccept
, DeskPhoneNumber
, and PhoneType
.public void setDirectoryUserId(String directoryUserId)
The unique identifier for the user account in the directory service directory used for identity management. If
Amazon Connect is unable to access the existing directory, you can use the DirectoryUserId
to
authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory.
If the parameter is not included, the UserIdentityInfo
is used to authenticate users from your
existing 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 InvalidRequestException
is returned.
directoryUserId
- The unique identifier for the user account in the directory service directory used for identity
management. If Amazon Connect is unable to access the existing directory, you can use the
DirectoryUserId
to authenticate users. If you include the parameter, it is assumed that
Amazon Connect cannot access the directory. If the parameter is not included, the
UserIdentityInfo
is used to authenticate users from your existing 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 InvalidRequestException
is returned.
public String getDirectoryUserId()
The unique identifier for the user account in the directory service directory used for identity management. If
Amazon Connect is unable to access the existing directory, you can use the DirectoryUserId
to
authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory.
If the parameter is not included, the UserIdentityInfo
is used to authenticate users from your
existing 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 InvalidRequestException
is returned.
DirectoryUserId
to authenticate users. If you include the parameter, it is assumed that
Amazon Connect cannot access the directory. If the parameter is not included, the
UserIdentityInfo
is used to authenticate users from your existing 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 InvalidRequestException
is returned.
public CreateUserRequest withDirectoryUserId(String directoryUserId)
The unique identifier for the user account in the directory service directory used for identity management. If
Amazon Connect is unable to access the existing directory, you can use the DirectoryUserId
to
authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory.
If the parameter is not included, the UserIdentityInfo
is used to authenticate users from your
existing 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 InvalidRequestException
is returned.
directoryUserId
- The unique identifier for the user account in the directory service directory used for identity
management. If Amazon Connect is unable to access the existing directory, you can use the
DirectoryUserId
to authenticate users. If you include the parameter, it is assumed that
Amazon Connect cannot access the directory. If the parameter is not included, the
UserIdentityInfo
is used to authenticate users from your existing 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 InvalidRequestException
is returned.
public List<String> getSecurityProfileIds()
The unique identifier of the security profile to assign to the user created.
public void setSecurityProfileIds(Collection<String> securityProfileIds)
The unique identifier of the security profile to assign to the user created.
securityProfileIds
- The unique identifier of the security profile to assign to the user created.public CreateUserRequest withSecurityProfileIds(String... securityProfileIds)
The unique identifier of the security profile to assign to the user created.
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.
securityProfileIds
- The unique identifier of the security profile to assign to the user created.public CreateUserRequest withSecurityProfileIds(Collection<String> securityProfileIds)
The unique identifier of the security profile to assign to the user created.
securityProfileIds
- The unique identifier of the security profile to assign to the user created.public void setRoutingProfileId(String routingProfileId)
The unique identifier for the routing profile to assign to the user created.
routingProfileId
- The unique identifier for the routing profile to assign to the user created.public String getRoutingProfileId()
The unique identifier for the routing profile to assign to the user created.
public CreateUserRequest withRoutingProfileId(String routingProfileId)
The unique identifier for the routing profile to assign to the user created.
routingProfileId
- The unique identifier for the routing profile to assign to the user created.public void setHierarchyGroupId(String hierarchyGroupId)
The unique identifier for the hierarchy group to assign to the user created.
hierarchyGroupId
- The unique identifier for the hierarchy group to assign to the user created.public String getHierarchyGroupId()
The unique identifier for the hierarchy group to assign to the user created.
public CreateUserRequest withHierarchyGroupId(String hierarchyGroupId)
The unique identifier for the hierarchy group to assign to the user created.
hierarchyGroupId
- The unique identifier for the hierarchy group to assign to the user created.public void setInstanceId(String instanceId)
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
instanceId
- The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and
select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is
displayed in the Overview section of your instance settings. For example, the instance ID is the set of
characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.public String getInstanceId()
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
public CreateUserRequest withInstanceId(String instanceId)
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
instanceId
- The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and
select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is
displayed in the Overview section of your instance settings. For example, the instance ID is the set of
characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.public String toString()
toString
in class Object
Object.toString()
public CreateUserRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.