@Generated(value="software.amazon.awssdk:codegen") public final class AdminCreateUserRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<AdminCreateUserRequest.Builder,AdminCreateUserRequest>
Represents the request to create a user in the specified user pool.
| Modifier and Type | Class and Description |
|---|---|
static interface |
AdminCreateUserRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static AdminCreateUserRequest.Builder |
builder() |
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.
|
List<DeliveryMediumType> |
desiredDeliveryMediums()
Specify
"EMAIL" if email will be used to send the welcome message. |
List<String> |
desiredDeliveryMediumsAsStrings()
Specify
"EMAIL" if email will be used to send the welcome message. |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
Boolean |
forceAliasCreation()
This parameter is only used if the
phone_number_verified or email_verified attribute is
set to True. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
boolean |
hasClientMetadata()
Returns true if the ClientMetadata property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasDesiredDeliveryMediums()
Returns true if the DesiredDeliveryMediums property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasUserAttributes()
Returns true if the UserAttributes property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasValidationData()
Returns true if the ValidationData property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
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. |
String |
messageActionAsString()
Set to
"RESEND" to resend the invitation message to a user that already exists and reset the
expiration limit on the user's account. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends AdminCreateUserRequest.Builder> |
serializableBuilderClass() |
String |
temporaryPassword()
The user's temporary password.
|
AdminCreateUserRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
List<AttributeType> |
userAttributes()
An array of name-value pairs that contain user attributes and attribute values to be set for the user to be
created.
|
String |
username()
The username for the user.
|
String |
userPoolId()
The user pool ID for the user pool where the user will be created.
|
List<AttributeType> |
validationData()
The user's validation data.
|
overrideConfigurationcopypublic final String userPoolId()
The user pool ID for the user pool where the user will be created.
public final String username()
The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
public final boolean hasUserAttributes()
public final List<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) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or
she signs up in response to your welcome message).
For custom attributes, you must prepend the custom: prefix to the attribute name.
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to
True, and you can set the phone_number_verified attribute to True. (You
can also do this by calling AdminUpdateUserAttributes.)
email: The email address of the user to whom the message that contains the code and username will be sent.
Required if the email_verified attribute is set to True, or if "EMAIL" is
specified in the DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the message that contains the code and username will be
sent. Required if the phone_number_verified attribute is set to True, or if
"SMS" is specified in the DesiredDeliveryMediums parameter.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasUserAttributes() to see if a value was sent in this field.
Username.
However, any attributes that you specify as required (when creating a user pool or in the
Attributes tab of the console) must be supplied either by you (in your call to
AdminCreateUser) or by the user (when he or she signs up in response to your welcome
message).
For custom attributes, you must prepend the custom: prefix to the attribute name.
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to
True, and you can set the phone_number_verified attribute to True.
(You can also do this by calling AdminUpdateUserAttributes.)
email: The email address of the user to whom the message that contains the code and username will
be sent. Required if the email_verified attribute is set to True, or if
"EMAIL" is specified in the DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the message that contains the code and username
will be sent. Required if the phone_number_verified attribute is set to True,
or if "SMS" is specified in the DesiredDeliveryMediums parameter.
public final boolean hasValidationData()
public final List<AttributeType> validationData()
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasValidationData() to see if a value was sent in this field.
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 final String temporaryPassword()
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you
created the user pool. To reset the account after that time limit, you must call AdminCreateUser
again, specifying "RESEND" for the MessageAction parameter.
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 final Boolean forceAliasCreation()
This parameter is only used if the phone_number_verified or email_verified attribute is
set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the
UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias
from the previous user to the newly created user. The previous user will no longer be able to log in using that
alias.
If this parameter is set to False, the API throws an AliasExistsException error if the
alias already exists. The default value is False.
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 final MessageActionType messageAction()
Set to "RESEND" to resend the invitation message to a user that already exists and reset the
expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one
value can be specified.
If the service returns an enum value that is not available in the current SDK version, messageAction
will return MessageActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from messageActionAsString().
"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.MessageActionTypepublic final String messageActionAsString()
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.
If the service returns an enum value that is not available in the current SDK version, messageAction
will return MessageActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from messageActionAsString().
"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.MessageActionTypepublic final List<DeliveryMediumType> desiredDeliveryMediums()
Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the
phone number will be used. The default value is "SMS". More than one value can be specified.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDesiredDeliveryMediums() to see if a value was sent in this field.
"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.public final boolean hasDesiredDeliveryMediums()
public final List<String> desiredDeliveryMediumsAsStrings()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDesiredDeliveryMediums() to see if a value was sent in this field.
"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.public final boolean hasClientMetadata()
public final 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 AWS 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 AWS 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.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasClientMetadata() to see if a value was sent in this field.
You create custom workflows by assigning AWS 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 AWS 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.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
public AdminCreateUserRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<AdminCreateUserRequest.Builder,AdminCreateUserRequest>toBuilder in class CognitoIdentityProviderRequestpublic static AdminCreateUserRequest.Builder builder()
public static Class<? extends AdminCreateUserRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.