AdminCreateUserRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidp.model.AdminCreateUserRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AdminCreateUserRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Represents the request to create a user in the specified user pool.

See Also:

AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

AdminCreateUserRequest()

Constructors
Constructor and Description
`AdminCreateUserRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdminCreateUserRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`List<String>`	`getDesiredDeliveryMediums()` Specify `"EMAIL"` if email will be used to send the welcome message.
`Boolean`	`getForceAliasCreation()` This parameter is only used if the `phone_number_verified` or `email_verified` attribute is set to `True`.
`String`	`getMessageAction()` Set to `"RESEND"` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
`String`	`getTemporaryPassword()` The user's temporary password.
`List<AttributeType>`	`getUserAttributes()` An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created.
`String`	`getUsername()` The username for the user.
`String`	`getUserPoolId()` The user pool ID for the user pool where the user will be created.
`List<AttributeType>`	`getValidationData()` The user's validation data.
`int`	`hashCode()`
`Boolean`	`isForceAliasCreation()` This parameter is only used if the `phone_number_verified` or `email_verified` attribute is set to `True`.
`void`	`setDesiredDeliveryMediums(Collection<String> desiredDeliveryMediums)` Specify `"EMAIL"` if email will be used to send the welcome message.
`void`	`setForceAliasCreation(Boolean forceAliasCreation)` This parameter is only used if the `phone_number_verified` or `email_verified` attribute is set to `True`.
`void`	`setMessageAction(MessageActionType messageAction)` Set to `"RESEND"` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
`void`	`setMessageAction(String messageAction)` Set to `"RESEND"` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
`void`	`setTemporaryPassword(String temporaryPassword)` The user's temporary password.
`void`	`setUserAttributes(Collection<AttributeType> userAttributes)` An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created.
`void`	`setUsername(String username)` The username for the user.
`void`	`setUserPoolId(String userPoolId)` The user pool ID for the user pool where the user will be created.
`void`	`setValidationData(Collection<AttributeType> validationData)` The user's validation data.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AdminCreateUserRequest`	`withDesiredDeliveryMediums(Collection<String> desiredDeliveryMediums)` Specify `"EMAIL"` if email will be used to send the welcome message.
`AdminCreateUserRequest`	`withDesiredDeliveryMediums(DeliveryMediumType... desiredDeliveryMediums)` Specify `"EMAIL"` if email will be used to send the welcome message.
`AdminCreateUserRequest`	`withDesiredDeliveryMediums(String... desiredDeliveryMediums)` Specify `"EMAIL"` if email will be used to send the welcome message.
`AdminCreateUserRequest`	`withForceAliasCreation(Boolean forceAliasCreation)` This parameter is only used if the `phone_number_verified` or `email_verified` attribute is set to `True`.
`AdminCreateUserRequest`	`withMessageAction(MessageActionType messageAction)` Set to `"RESEND"` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
`AdminCreateUserRequest`	`withMessageAction(String messageAction)` Set to `"RESEND"` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
`AdminCreateUserRequest`	`withTemporaryPassword(String temporaryPassword)` The user's temporary password.
`AdminCreateUserRequest`	`withUserAttributes(AttributeType... userAttributes)` An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created.
`AdminCreateUserRequest`	`withUserAttributes(Collection<AttributeType> userAttributes)` An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created.
`AdminCreateUserRequest`	`withUsername(String username)` The username for the user.
`AdminCreateUserRequest`	`withUserPoolId(String userPoolId)` The user pool ID for the user pool where the user will be created.
`AdminCreateUserRequest`	`withValidationData(AttributeType... validationData)` The user's validation data.
`AdminCreateUserRequest`	`withValidationData(Collection<AttributeType> validationData)` The user's validation data.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AdminCreateUserRequest
```
public AdminCreateUserRequest()
```
- Method Detail
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID for the user pool where the user will be created.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool where the user will be created.
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID for the user pool where the user will be created.
    
    Returns:
    
    The user pool ID for the user pool where the user will be created.
  - withUserPoolId
```
public AdminCreateUserRequest withUserPoolId(String userPoolId)
```
    The user pool ID for the user pool where the user will be created.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool where the user will be created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsername
```
public void setUsername(String username)
```
    The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
    
    Parameters:
    
    username - The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
  - getUsername
```
public String getUsername()
```
    The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
    
    Returns:
    
    The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
  - withUsername
```
public AdminCreateUserRequest withUsername(String username)
```
    The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
    
    Parameters:
    
    username - The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserAttributes
```
public List<AttributeType> getUserAttributes()
```
    An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
    
    For custom attributes, you must prepend the custom: prefix to the attribute name.
    
    To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
    
    In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You can also do this by calling AdminUpdateUserAttributes.)
    - email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.
    - phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
    Returns:
    An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
    
    For custom attributes, you must prepend the custom: prefix to the attribute name.
    
    To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
    
    In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You can also do this by calling AdminUpdateUserAttributes.)
    
    email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.
    
    phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
  - setUserAttributes
```
public void setUserAttributes(Collection<AttributeType> userAttributes)
```
    An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
    
    For custom attributes, you must prepend the custom: prefix to the attribute name.
    
    To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
    
    In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You can also do this by calling AdminUpdateUserAttributes.)
    - email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.
    - phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
    Parameters:
    userAttributes - An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
    
    For custom attributes, you must prepend the custom: prefix to the attribute name.
    
    To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
    
    In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You can also do this by calling AdminUpdateUserAttributes.)
    
    email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.
    
    phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
  - withUserAttributes
```
public AdminCreateUserRequest withUserAttributes(AttributeType... userAttributes)
```
    An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
    
    For custom attributes, you must prepend the custom: prefix to the attribute name.
    
    To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
    
    In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You can also do this by calling AdminUpdateUserAttributes.)
    - email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.
    - phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
    NOTE: This method appends the values to the existing list (if any). Use setUserAttributes(java.util.Collection) or withUserAttributes(java.util.Collection) if you want to override the existing values.
    Parameters:
    userAttributes - An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
    
    For custom attributes, you must prepend the custom: prefix to the attribute name.
    
    To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
    
    In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You can also do this by calling AdminUpdateUserAttributes.)
    
    email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.
    
    phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUserAttributes
```
public AdminCreateUserRequest withUserAttributes(Collection<AttributeType> userAttributes)
```
    An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
    
    For custom attributes, you must prepend the custom: prefix to the attribute name.
    
    To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
    
    In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You can also do this by calling AdminUpdateUserAttributes.)
    - email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.
    - phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
    Parameters:
    userAttributes - An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
    
    For custom attributes, you must prepend the custom: prefix to the attribute name.
    
    To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
    
    In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You can also do this by calling AdminUpdateUserAttributes.)
    
    email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.
    
    phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getValidationData
```
public List<AttributeType> getValidationData()
```
    The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
    
    To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
    
    The user's validation data is not persisted.
    
    Returns:
    
    The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
    
    To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
    
    The user's validation data is not persisted.
  - setValidationData
```
public void setValidationData(Collection<AttributeType> validationData)
```
    The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
    
    To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
    
    The user's validation data is not persisted.
    
    Parameters:
    
    validationData - The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
    
    To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
    
    The user's validation data is not persisted.
  - withValidationData
```
public AdminCreateUserRequest withValidationData(AttributeType... validationData)
```
    The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
    
    To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
    
    The user's validation data is not persisted.
    
    NOTE: This method appends the values to the existing list (if any). Use setValidationData(java.util.Collection) or withValidationData(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    validationData - The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
    
    To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
    
    The user's validation data is not persisted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withValidationData
```
public AdminCreateUserRequest withValidationData(Collection<AttributeType> validationData)
```
    The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
    
    To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
    
    The user's validation data is not persisted.
    
    Parameters:
    
    validationData - The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
    
    To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
    
    The user's validation data is not persisted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemporaryPassword
```
public void setTemporaryPassword(String temporaryPassword)
```
    The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
    
    The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
    
    This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
    
    The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter.
    
    Parameters:
    
    temporaryPassword - The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
    
    The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
    
    This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
    
    The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter.
  - getTemporaryPassword
```
public String getTemporaryPassword()
```
    The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
    
    The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
    
    This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
    
    The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter.
    
    Returns:
    
    The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
    
    The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
    
    This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
    
    The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter.
  - withTemporaryPassword
```
public AdminCreateUserRequest withTemporaryPassword(String temporaryPassword)
```
    The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
    
    The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
    
    This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
    
    The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter.
    
    Parameters:
    
    temporaryPassword - The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
    
    The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
    
    This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
    
    The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setForceAliasCreation
```
public void setForceAliasCreation(Boolean forceAliasCreation)
```
    This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
    
    If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
    
    If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
    
    Parameters:
    
    forceAliasCreation - This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
    
    If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
    
    If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
  - getForceAliasCreation
```
public Boolean getForceAliasCreation()
```
    This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
    
    If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
    
    If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
    
    Returns:
    
    This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
    
    If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
    
    If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
  - withForceAliasCreation
```
public AdminCreateUserRequest withForceAliasCreation(Boolean forceAliasCreation)
```
    This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
    
    If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
    
    If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
    
    Parameters:
    
    forceAliasCreation - This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
    
    If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
    
    If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isForceAliasCreation
```
public Boolean isForceAliasCreation()
```
    This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
    
    If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
    
    If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
    
    Returns:
    
    This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
    
    If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
    
    If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
  - setMessageAction
```
public void setMessageAction(String messageAction)
```
    Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified.
    
    Parameters:
    
    messageAction - Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified.
    
    See Also:
    
    MessageActionType
  - getMessageAction
```
public String getMessageAction()
```
    Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified.
    
    Returns:
    
    Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified.
    
    See Also:
    
    MessageActionType
  - withMessageAction
```
public AdminCreateUserRequest withMessageAction(String messageAction)
```
    Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified.
    
    Parameters:
    
    messageAction - Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageActionType
  - setMessageAction
```
public void setMessageAction(MessageActionType messageAction)
```
    Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified.
    
    Parameters:
    
    messageAction - Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified.
    
    See Also:
    
    MessageActionType
  - withMessageAction
```
public AdminCreateUserRequest withMessageAction(MessageActionType messageAction)
```
    Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified.
    
    Parameters:
    
    messageAction - Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageActionType
  - getDesiredDeliveryMediums
```
public List<String> getDesiredDeliveryMediums()
```
    Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified.
    
    Returns:
    
    Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified.
    
    See Also:
    
    DeliveryMediumType
  - setDesiredDeliveryMediums
```
public void setDesiredDeliveryMediums(Collection<String> desiredDeliveryMediums)
```
    Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified.
    
    Parameters:
    
    desiredDeliveryMediums - Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified.
    
    See Also:
    
    DeliveryMediumType
  - withDesiredDeliveryMediums
```
public AdminCreateUserRequest withDesiredDeliveryMediums(String... desiredDeliveryMediums)
```
    Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified.
    
    NOTE: This method appends the values to the existing list (if any). Use setDesiredDeliveryMediums(java.util.Collection) or withDesiredDeliveryMediums(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    desiredDeliveryMediums - Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeliveryMediumType
  - withDesiredDeliveryMediums
```
public AdminCreateUserRequest withDesiredDeliveryMediums(Collection<String> desiredDeliveryMediums)
```
    Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified.
    
    Parameters:
    
    desiredDeliveryMediums - Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeliveryMediumType
  - withDesiredDeliveryMediums
```
public AdminCreateUserRequest withDesiredDeliveryMediums(DeliveryMediumType... desiredDeliveryMediums)
```
    Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified.
    
    Parameters:
    
    desiredDeliveryMediums - Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeliveryMediumType
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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 AdminCreateUserRequest 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()

Did this page help you?

Class AdminCreateUserRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AdminCreateUserRequest

Method Detail

setUserPoolId

getUserPoolId

withUserPoolId

setUsername

getUsername

withUsername

getUserAttributes

setUserAttributes

withUserAttributes

withUserAttributes

getValidationData

setValidationData

withValidationData

withValidationData

setTemporaryPassword

getTemporaryPassword

withTemporaryPassword

setForceAliasCreation

getForceAliasCreation

withForceAliasCreation

isForceAliasCreation

setMessageAction

getMessageAction

withMessageAction

setMessageAction

withMessageAction

getDesiredDeliveryMediums

setDesiredDeliveryMediums

withDesiredDeliveryMediums

withDesiredDeliveryMediums

withDesiredDeliveryMediums

toString

equals

hashCode

clone