com.amazonaws.services.cognitoidp.model.AdminCreateUserRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cognitoidp Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cognitoidp.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the request to create a user in the specified user pool.
*
*/
public class AdminCreateUserRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The user pool ID for the user pool where the user will be created.
*
*/
private String userPoolId;
/**
*
* 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.
*
*/
private String username;
/**
*
* 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).
*
*
* 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 cannot do this by calling other operations such as
* 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.
*
*
*
*/
private java.util.List userAttributes;
/**
*
* 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.
*
*/
private java.util.List validationData;
/**
*
* 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.
*
*/
private String temporaryPassword;
/**
*
* 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.
*
*/
private Boolean forceAliasCreation;
/**
*
* 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.
*
*/
private String messageAction;
/**
*
* 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.
*
*/
private java.util.List desiredDeliveryMediums;
/**
*
* The user pool ID for the user pool where the user will be created.
*
*
* @param userPoolId
* The user pool ID for the user pool where the user will be created.
*/
public void setUserPoolId(String userPoolId) {
this.userPoolId = userPoolId;
}
/**
*
* The user pool ID for the user pool where the user will be created.
*
*
* @return The user pool ID for the user pool where the user will be created.
*/
public String getUserPoolId() {
return this.userPoolId;
}
/**
*
* The user pool ID for the user pool where the user will be created.
*
*
* @param userPoolId
* The user pool ID for the user pool where the user will be created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminCreateUserRequest withUserPoolId(String userPoolId) {
setUserPoolId(userPoolId);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setUsername(String username) {
this.username = 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.
*
*
* @return 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.
*/
public String getUsername() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminCreateUserRequest withUsername(String username) {
setUsername(username);
return this;
}
/**
*
* 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).
*
*
* 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 cannot do this by calling other operations such as
* 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.
*
*
*
*
* @return 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).
*
* 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 cannot do this by calling other operations such as
* 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.
*
*
*/
public java.util.List getUserAttributes() {
return 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).
*
*
* 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 cannot do this by calling other operations such as
* 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.
*
*
*
*
* @param 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).
*
* 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 cannot do this by calling other operations such as
* 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.
*
*
*/
public void setUserAttributes(java.util.Collection userAttributes) {
if (userAttributes == null) {
this.userAttributes = null;
return;
}
this.userAttributes = new java.util.ArrayList(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).
*
*
* 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 cannot do this by calling other operations such as
* 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
* {@link #setUserAttributes(java.util.Collection)} or {@link #withUserAttributes(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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).
*
* 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 cannot do this by calling other operations such as
* 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminCreateUserRequest withUserAttributes(AttributeType... userAttributes) {
if (this.userAttributes == null) {
setUserAttributes(new java.util.ArrayList(userAttributes.length));
}
for (AttributeType ele : userAttributes) {
this.userAttributes.add(ele);
}
return this;
}
/**
*
* 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).
*
*
* 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 cannot do this by calling other operations such as
* 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.
*
*
*
*
* @param 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).
*
* 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 cannot do this by calling other operations such as
* 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminCreateUserRequest withUserAttributes(java.util.Collection userAttributes) {
setUserAttributes(userAttributes);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getValidationData() {
return 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.
*
*
* @param 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.
*/
public void setValidationData(java.util.Collection validationData) {
if (validationData == null) {
this.validationData = null;
return;
}
this.validationData = new java.util.ArrayList(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
* {@link #setValidationData(java.util.Collection)} or {@link #withValidationData(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminCreateUserRequest withValidationData(AttributeType... validationData) {
if (this.validationData == null) {
setValidationData(new java.util.ArrayList(validationData.length));
}
for (AttributeType ele : validationData) {
this.validationData.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminCreateUserRequest withValidationData(java.util.Collection validationData) {
setValidationData(validationData);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setTemporaryPassword(String temporaryPassword) {
this.temporaryPassword = 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.
*
*
* @return 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.
*/
public String getTemporaryPassword() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminCreateUserRequest withTemporaryPassword(String temporaryPassword) {
setTemporaryPassword(temporaryPassword);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setForceAliasCreation(Boolean forceAliasCreation) {
this.forceAliasCreation = 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.
*
*
* @return 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.
*/
public Boolean getForceAliasCreation() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminCreateUserRequest withForceAliasCreation(Boolean forceAliasCreation) {
setForceAliasCreation(forceAliasCreation);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isForceAliasCreation() {
return this.forceAliasCreation;
}
/**
*
* 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.
*
*
* @param 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 MessageActionType
*/
public void setMessageAction(String messageAction) {
this.messageAction = 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.
*
*
* @return 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 MessageActionType
*/
public String getMessageAction() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageActionType
*/
public AdminCreateUserRequest withMessageAction(String messageAction) {
setMessageAction(messageAction);
return this;
}
/**
*
* 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.
*
*
* @param 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 MessageActionType
*/
public void setMessageAction(MessageActionType messageAction) {
this.messageAction = messageAction.toString();
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageActionType
*/
public AdminCreateUserRequest withMessageAction(MessageActionType messageAction) {
setMessageAction(messageAction);
return this;
}
/**
*
* 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.
*
*
* @return 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 DeliveryMediumType
*/
public java.util.List getDesiredDeliveryMediums() {
return 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.
*
*
* @param 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 DeliveryMediumType
*/
public void setDesiredDeliveryMediums(java.util.Collection desiredDeliveryMediums) {
if (desiredDeliveryMediums == null) {
this.desiredDeliveryMediums = null;
return;
}
this.desiredDeliveryMediums = new java.util.ArrayList(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
* {@link #setDesiredDeliveryMediums(java.util.Collection)} or
* {@link #withDesiredDeliveryMediums(java.util.Collection)} if you want to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeliveryMediumType
*/
public AdminCreateUserRequest withDesiredDeliveryMediums(String... desiredDeliveryMediums) {
if (this.desiredDeliveryMediums == null) {
setDesiredDeliveryMediums(new java.util.ArrayList(desiredDeliveryMediums.length));
}
for (String ele : desiredDeliveryMediums) {
this.desiredDeliveryMediums.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeliveryMediumType
*/
public AdminCreateUserRequest withDesiredDeliveryMediums(java.util.Collection desiredDeliveryMediums) {
setDesiredDeliveryMediums(desiredDeliveryMediums);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeliveryMediumType
*/
public AdminCreateUserRequest withDesiredDeliveryMediums(DeliveryMediumType... desiredDeliveryMediums) {
java.util.ArrayList desiredDeliveryMediumsCopy = new java.util.ArrayList(desiredDeliveryMediums.length);
for (DeliveryMediumType value : desiredDeliveryMediums) {
desiredDeliveryMediumsCopy.add(value.toString());
}
if (getDesiredDeliveryMediums() == null) {
setDesiredDeliveryMediums(desiredDeliveryMediumsCopy);
} else {
getDesiredDeliveryMediums().addAll(desiredDeliveryMediumsCopy);
}
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getUserPoolId() != null)
sb.append("UserPoolId: " + getUserPoolId() + ",");
if (getUsername() != null)
sb.append("Username: " + getUsername() + ",");
if (getUserAttributes() != null)
sb.append("UserAttributes: " + getUserAttributes() + ",");
if (getValidationData() != null)
sb.append("ValidationData: " + getValidationData() + ",");
if (getTemporaryPassword() != null)
sb.append("TemporaryPassword: " + getTemporaryPassword() + ",");
if (getForceAliasCreation() != null)
sb.append("ForceAliasCreation: " + getForceAliasCreation() + ",");
if (getMessageAction() != null)
sb.append("MessageAction: " + getMessageAction() + ",");
if (getDesiredDeliveryMediums() != null)
sb.append("DesiredDeliveryMediums: " + getDesiredDeliveryMediums());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AdminCreateUserRequest == false)
return false;
AdminCreateUserRequest other = (AdminCreateUserRequest) obj;
if (other.getUserPoolId() == null ^ this.getUserPoolId() == null)
return false;
if (other.getUserPoolId() != null && other.getUserPoolId().equals(this.getUserPoolId()) == false)
return false;
if (other.getUsername() == null ^ this.getUsername() == null)
return false;
if (other.getUsername() != null && other.getUsername().equals(this.getUsername()) == false)
return false;
if (other.getUserAttributes() == null ^ this.getUserAttributes() == null)
return false;
if (other.getUserAttributes() != null && other.getUserAttributes().equals(this.getUserAttributes()) == false)
return false;
if (other.getValidationData() == null ^ this.getValidationData() == null)
return false;
if (other.getValidationData() != null && other.getValidationData().equals(this.getValidationData()) == false)
return false;
if (other.getTemporaryPassword() == null ^ this.getTemporaryPassword() == null)
return false;
if (other.getTemporaryPassword() != null && other.getTemporaryPassword().equals(this.getTemporaryPassword()) == false)
return false;
if (other.getForceAliasCreation() == null ^ this.getForceAliasCreation() == null)
return false;
if (other.getForceAliasCreation() != null && other.getForceAliasCreation().equals(this.getForceAliasCreation()) == false)
return false;
if (other.getMessageAction() == null ^ this.getMessageAction() == null)
return false;
if (other.getMessageAction() != null && other.getMessageAction().equals(this.getMessageAction()) == false)
return false;
if (other.getDesiredDeliveryMediums() == null ^ this.getDesiredDeliveryMediums() == null)
return false;
if (other.getDesiredDeliveryMediums() != null && other.getDesiredDeliveryMediums().equals(this.getDesiredDeliveryMediums()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUserPoolId() == null) ? 0 : getUserPoolId().hashCode());
hashCode = prime * hashCode + ((getUsername() == null) ? 0 : getUsername().hashCode());
hashCode = prime * hashCode + ((getUserAttributes() == null) ? 0 : getUserAttributes().hashCode());
hashCode = prime * hashCode + ((getValidationData() == null) ? 0 : getValidationData().hashCode());
hashCode = prime * hashCode + ((getTemporaryPassword() == null) ? 0 : getTemporaryPassword().hashCode());
hashCode = prime * hashCode + ((getForceAliasCreation() == null) ? 0 : getForceAliasCreation().hashCode());
hashCode = prime * hashCode + ((getMessageAction() == null) ? 0 : getMessageAction().hashCode());
hashCode = prime * hashCode + ((getDesiredDeliveryMediums() == null) ? 0 : getDesiredDeliveryMediums().hashCode());
return hashCode;
}
@Override
public AdminCreateUserRequest clone() {
return (AdminCreateUserRequest) super.clone();
}
}