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`	`addClientMetadataEntry(String key, String value)` Add a single ClientMetadata entry
`AdminCreateUserRequest`	`clearClientMetadataEntries()` Removes all the entries added into ClientMetadata.
`AdminCreateUserRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getClientMetadata()` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`List<String>`	`getDesiredDeliveryMediums()` Specify `"EMAIL"` if email will be used to send the welcome message.
`Boolean`	`getForceAliasCreation()` This parameter is used only 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 value that you want to set as the username sign-in attribute.
`String`	`getUserPoolId()` The user pool ID for the user pool where the user will be created.
`List<AttributeType>`	`getValidationData()` Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.
`int`	`hashCode()`
`Boolean`	`isForceAliasCreation()` This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True`.
`void`	`setClientMetadata(Map<String,String> clientMetadata)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`void`	`setDesiredDeliveryMediums(Collection<String> desiredDeliveryMediums)` Specify `"EMAIL"` if email will be used to send the welcome message.
`void`	`setForceAliasCreation(Boolean forceAliasCreation)` This parameter is used only 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 value that you want to set as the username sign-in attribute.
`void`	`setUserPoolId(String userPoolId)` The user pool ID for the user pool where the user will be created.
`void`	`setValidationData(Collection<AttributeType> validationData)` Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.
`String`	`toString()` Returns a string representation of this object.
`AdminCreateUserRequest`	`withClientMetadata(Map<String,String> clientMetadata)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`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 used only 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 value that you want to set as the username sign-in attribute.
`AdminCreateUserRequest`	`withUserPoolId(String userPoolId)` The user pool ID for the user pool where the user will be created.
`AdminCreateUserRequest`	`withValidationData(AttributeType... validationData)` Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.
`AdminCreateUserRequest`	`withValidationData(Collection<AttributeType> validationData)` Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.

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 value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.
    - The username can't be a duplicate of another username in the same user pool.
    - You can't change the value of a username after you create it.
    - You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes.
    Parameters:
    username - The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.
    
    The username can't be a duplicate of another username in the same user pool.
    
    You can't change the value of a username after you create it.
    
    You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes.
  - getUsername
```
public String getUsername()
```
    The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.
    - The username can't be a duplicate of another username in the same user pool.
    - You can't change the value of a username after you create it.
    - You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes.
    Returns:
    The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.
    
    The username can't be a duplicate of another username in the same user pool.
    
    You can't change the value of a username after you create it.
    
    You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes.
  - withUsername
```
public AdminCreateUserRequest withUsername(String username)
```
    The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.
    - The username can't be a duplicate of another username in the same user pool.
    - You can't change the value of a username after you create it.
    - You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes.
    Parameters:
    username - The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.
    
    The username can't be a duplicate of another username in the same user pool.
    
    You can't change the value of a username after you create it.
    
    You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes.
    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 (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign 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. You can do this 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 (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign 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. You can do this 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 (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign 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. You can do this 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 (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign 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. You can do this 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 (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign 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. You can do this 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 (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign 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. You can do this 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 (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign 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. You can do this 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 (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign 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. You can do this 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()
```
    Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
    
    Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
    
    For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
    
    Returns:
    
    Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
    
    Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
    
    For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
  - setValidationData
```
public void setValidationData(Collection<AttributeType> validationData)
```
    Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
    
    Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
    
    For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
    
    Parameters:
    
    validationData - Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
    
    Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
    
    For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
  - withValidationData
```
public AdminCreateUserRequest withValidationData(AttributeType... validationData)
```
    Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
    
    Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
    
    For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
    
    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 - Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
    
    Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
    
    For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withValidationData
```
public AdminCreateUserRequest withValidationData(Collection<AttributeType> validationData)
```
    Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
    
    Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
    
    For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
    
    Parameters:
    
    validationData - Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
    
    Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
    
    For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
    
    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 isn't required. If you don't specify a value, Amazon Cognito generates one for you.
    
    The temporary password can only be used until the user account expiration limit that you set for your user pool. To reset the account after that time limit, you must call AdminCreateUser again and specify 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 isn't required. If you don't specify a value, Amazon Cognito generates one for you.
    
    The temporary password can only be used until the user account expiration limit that you set for your user pool. To reset the account after that time limit, you must call AdminCreateUser again and specify 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 isn't required. If you don't specify a value, Amazon Cognito generates one for you.
    
    The temporary password can only be used until the user account expiration limit that you set for your user pool. To reset the account after that time limit, you must call AdminCreateUser again and specify 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 isn't required. If you don't specify a value, Amazon Cognito generates one for you.
    
    The temporary password can only be used until the user account expiration limit that you set for your user pool. To reset the account after that time limit, you must call AdminCreateUser again and specify 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 isn't required. If you don't specify a value, Amazon Cognito generates one for you.
    
    The temporary password can only be used until the user account expiration limit that you set for your user pool. To reset the account after that time limit, you must call AdminCreateUser again and specify 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 isn't required. If you don't specify a value, Amazon Cognito generates one for you.
    
    The temporary password can only be used until the user account expiration limit that you set for your user pool. To reset the account after that time limit, you must call AdminCreateUser again and specify 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 used only 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 used only 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 used only 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 used only 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 used only 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 used only 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 used only 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 used only 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. You can specify only one value.
    
    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. You can specify only one value.
    
    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. You can specify only one value.
    
    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. You can specify only one value.
    
    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. You can specify only one value.
    
    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. You can specify only one value.
    
    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. You can specify only one value.
    
    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. You can specify only one value.
    
    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. You can specify only one value.
    
    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. You can specify only one value.
    
    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". You can specify more than one value.
    
    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". You can specify more than one value.
    
    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". You can specify more than one value.
    
    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". You can specify more than one value.
    
    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". You can specify more than one value.
    
    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". You can specify more than one value.
    
    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". You can specify more than one value.
    
    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". You can specify more than one value.
    
    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". You can specify more than one value.
    
    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". You can specify more than one value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeliveryMediumType
  - getClientMetadata
```
public Map<String,String> getClientMetadata()
```
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns:
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
  - setClientMetadata
```
public void setClientMetadata(Map<String,String> clientMetadata)
```
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Parameters:
    clientMetadata - A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
  - withClientMetadata
```
public AdminCreateUserRequest withClientMetadata(Map<String,String> clientMetadata)
```
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Parameters:
    clientMetadata - A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addClientMetadataEntry
```
public AdminCreateUserRequest addClientMetadataEntry(String key,
                                                     String value)
```
    Add a single ClientMetadata entry
    
    See Also:
    
    withClientMetadata(java.util.Map<java.lang.String, java.lang.String>)
  - clearClientMetadataEntries
```
public AdminCreateUserRequest clearClientMetadataEntries()
```
    Removes all the entries added into ClientMetadata.
    
    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 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()

AWS SDK for Java 1.x API Reference - 1.12.779

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

getClientMetadata

setClientMetadata

withClientMetadata

addClientMetadataEntry

clearClientMetadataEntries

toString

equals

hashCode

clone