AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest Class Reference

#include <AdminCreateUserRequest.h>

+ Inheritance diagram for Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest:

Public Member Functions

 AdminCreateUserRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetUserPoolId () const
 
bool UserPoolIdHasBeenSet () const
 
void SetUserPoolId (const Aws::String &value)
 
void SetUserPoolId (Aws::String &&value)
 
void SetUserPoolId (const char *value)
 
AdminCreateUserRequestWithUserPoolId (const Aws::String &value)
 
AdminCreateUserRequestWithUserPoolId (Aws::String &&value)
 
AdminCreateUserRequestWithUserPoolId (const char *value)
 
const Aws::StringGetUsername () const
 
bool UsernameHasBeenSet () const
 
void SetUsername (const Aws::String &value)
 
void SetUsername (Aws::String &&value)
 
void SetUsername (const char *value)
 
AdminCreateUserRequestWithUsername (const Aws::String &value)
 
AdminCreateUserRequestWithUsername (Aws::String &&value)
 
AdminCreateUserRequestWithUsername (const char *value)
 
const Aws::Vector< AttributeType > & GetUserAttributes () const
 
bool UserAttributesHasBeenSet () const
 
void SetUserAttributes (const Aws::Vector< AttributeType > &value)
 
void SetUserAttributes (Aws::Vector< AttributeType > &&value)
 
AdminCreateUserRequestWithUserAttributes (const Aws::Vector< AttributeType > &value)
 
AdminCreateUserRequestWithUserAttributes (Aws::Vector< AttributeType > &&value)
 
AdminCreateUserRequestAddUserAttributes (const AttributeType &value)
 
AdminCreateUserRequestAddUserAttributes (AttributeType &&value)
 
const Aws::Vector< AttributeType > & GetValidationData () const
 
bool ValidationDataHasBeenSet () const
 
void SetValidationData (const Aws::Vector< AttributeType > &value)
 
void SetValidationData (Aws::Vector< AttributeType > &&value)
 
AdminCreateUserRequestWithValidationData (const Aws::Vector< AttributeType > &value)
 
AdminCreateUserRequestWithValidationData (Aws::Vector< AttributeType > &&value)
 
AdminCreateUserRequestAddValidationData (const AttributeType &value)
 
AdminCreateUserRequestAddValidationData (AttributeType &&value)
 
const Aws::StringGetTemporaryPassword () const
 
bool TemporaryPasswordHasBeenSet () const
 
void SetTemporaryPassword (const Aws::String &value)
 
void SetTemporaryPassword (Aws::String &&value)
 
void SetTemporaryPassword (const char *value)
 
AdminCreateUserRequestWithTemporaryPassword (const Aws::String &value)
 
AdminCreateUserRequestWithTemporaryPassword (Aws::String &&value)
 
AdminCreateUserRequestWithTemporaryPassword (const char *value)
 
bool GetForceAliasCreation () const
 
bool ForceAliasCreationHasBeenSet () const
 
void SetForceAliasCreation (bool value)
 
AdminCreateUserRequestWithForceAliasCreation (bool value)
 
const MessageActionTypeGetMessageAction () const
 
bool MessageActionHasBeenSet () const
 
void SetMessageAction (const MessageActionType &value)
 
void SetMessageAction (MessageActionType &&value)
 
AdminCreateUserRequestWithMessageAction (const MessageActionType &value)
 
AdminCreateUserRequestWithMessageAction (MessageActionType &&value)
 
const Aws::Vector< DeliveryMediumType > & GetDesiredDeliveryMediums () const
 
bool DesiredDeliveryMediumsHasBeenSet () const
 
void SetDesiredDeliveryMediums (const Aws::Vector< DeliveryMediumType > &value)
 
void SetDesiredDeliveryMediums (Aws::Vector< DeliveryMediumType > &&value)
 
AdminCreateUserRequestWithDesiredDeliveryMediums (const Aws::Vector< DeliveryMediumType > &value)
 
AdminCreateUserRequestWithDesiredDeliveryMediums (Aws::Vector< DeliveryMediumType > &&value)
 
AdminCreateUserRequestAddDesiredDeliveryMediums (const DeliveryMediumType &value)
 
AdminCreateUserRequestAddDesiredDeliveryMediums (DeliveryMediumType &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetClientMetadata () const
 
bool ClientMetadataHasBeenSet () const
 
void SetClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
AdminCreateUserRequestWithClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
AdminCreateUserRequestWithClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
AdminCreateUserRequestAddClientMetadata (const Aws::String &key, const Aws::String &value)
 
AdminCreateUserRequestAddClientMetadata (Aws::String &&key, const Aws::String &value)
 
AdminCreateUserRequestAddClientMetadata (const Aws::String &key, Aws::String &&value)
 
AdminCreateUserRequestAddClientMetadata (Aws::String &&key, Aws::String &&value)
 
AdminCreateUserRequestAddClientMetadata (const char *key, Aws::String &&value)
 
AdminCreateUserRequestAddClientMetadata (Aws::String &&key, const char *value)
 
AdminCreateUserRequestAddClientMetadata (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest
virtual ~CognitoIdentityProviderRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Represents the request to create a user in the specified user pool.

See Also:

AWS API Reference

Definition at line 30 of file AdminCreateUserRequest.h.

Constructor & Destructor Documentation

◆ AdminCreateUserRequest()

Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AdminCreateUserRequest ( )

Member Function Documentation

◆ AddClientMetadata() [1/7]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AddClientMetadata ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 1004 of file AdminCreateUserRequest.h.

◆ AddClientMetadata() [2/7]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AddClientMetadata ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 952 of file AdminCreateUserRequest.h.

◆ AddClientMetadata() [3/7]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AddClientMetadata ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 1056 of file AdminCreateUserRequest.h.

◆ AddClientMetadata() [4/7]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AddClientMetadata ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 978 of file AdminCreateUserRequest.h.

◆ AddClientMetadata() [5/7]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AddClientMetadata ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 926 of file AdminCreateUserRequest.h.

◆ AddClientMetadata() [6/7]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AddClientMetadata ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 1030 of file AdminCreateUserRequest.h.

◆ AddClientMetadata() [7/7]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AddClientMetadata ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 1082 of file AdminCreateUserRequest.h.

◆ AddDesiredDeliveryMediums() [1/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AddDesiredDeliveryMediums ( const DeliveryMediumType value)
inline

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.

Definition at line 736 of file AdminCreateUserRequest.h.

◆ AddDesiredDeliveryMediums() [2/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AddDesiredDeliveryMediums ( DeliveryMediumType &&  value)
inline

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.

Definition at line 743 of file AdminCreateUserRequest.h.

◆ AddUserAttributes() [1/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AddUserAttributes ( AttributeType &&  value)
inline

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.

Definition at line 374 of file AdminCreateUserRequest.h.

◆ AddUserAttributes() [2/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AddUserAttributes ( const AttributeType value)
inline

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.

Definition at line 345 of file AdminCreateUserRequest.h.

◆ AddValidationData() [1/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AddValidationData ( AttributeType &&  value)
inline

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.

Definition at line 471 of file AdminCreateUserRequest.h.

◆ AddValidationData() [2/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::AddValidationData ( const AttributeType value)
inline

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.

Definition at line 459 of file AdminCreateUserRequest.h.

◆ ClientMetadataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::ClientMetadataHasBeenSet ( ) const
inline

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.

Definition at line 796 of file AdminCreateUserRequest.h.

◆ DesiredDeliveryMediumsHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::DesiredDeliveryMediumsHasBeenSet ( ) const
inline

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.

Definition at line 701 of file AdminCreateUserRequest.h.

◆ ForceAliasCreationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::ForceAliasCreationHasBeenSet ( ) const
inline

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.

Definition at line 611 of file AdminCreateUserRequest.h.

◆ GetClientMetadata()

const Aws::Map<Aws::String, Aws::String>& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::GetClientMetadata ( ) const
inline

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.

Definition at line 770 of file AdminCreateUserRequest.h.

◆ GetDesiredDeliveryMediums()

const Aws::Vector<DeliveryMediumType>& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::GetDesiredDeliveryMediums ( ) const
inline

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.

Definition at line 694 of file AdminCreateUserRequest.h.

◆ GetForceAliasCreation()

bool Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::GetForceAliasCreation ( ) const
inline

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.

Definition at line 598 of file AdminCreateUserRequest.h.

◆ GetMessageAction()

const MessageActionType& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::GetMessageAction ( ) const
inline

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.

Definition at line 646 of file AdminCreateUserRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file AdminCreateUserRequest.h.

◆ GetTemporaryPassword()

const Aws::String& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::GetTemporaryPassword ( ) const
inline

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.

Definition at line 486 of file AdminCreateUserRequest.h.

◆ GetUserAttributes()

const Aws::Vector<AttributeType>& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::GetUserAttributes ( ) const
inline

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.

Definition at line 171 of file AdminCreateUserRequest.h.

◆ GetUsername()

const Aws::String& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::GetUsername ( ) const
inline

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.

Definition at line 92 of file AdminCreateUserRequest.h.

◆ GetUserPoolId()

const Aws::String& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::GetUserPoolId ( ) const
inline

The user pool ID for the user pool where the user will be created.

Definition at line 49 of file AdminCreateUserRequest.h.

◆ GetValidationData()

const Aws::Vector<AttributeType>& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::GetValidationData ( ) const
inline

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.

Definition at line 387 of file AdminCreateUserRequest.h.

◆ MessageActionHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::MessageActionHasBeenSet ( ) const
inline

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.

Definition at line 654 of file AdminCreateUserRequest.h.

◆ SerializePayload()

Aws::String Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientMetadata() [1/2]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetClientMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 848 of file AdminCreateUserRequest.h.

◆ SetClientMetadata() [2/2]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetClientMetadata ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 822 of file AdminCreateUserRequest.h.

◆ SetDesiredDeliveryMediums() [1/2]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetDesiredDeliveryMediums ( Aws::Vector< DeliveryMediumType > &&  value)
inline

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.

Definition at line 715 of file AdminCreateUserRequest.h.

◆ SetDesiredDeliveryMediums() [2/2]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetDesiredDeliveryMediums ( const Aws::Vector< DeliveryMediumType > &  value)
inline

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.

Definition at line 708 of file AdminCreateUserRequest.h.

◆ SetForceAliasCreation()

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetForceAliasCreation ( bool  value)
inline

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.

Definition at line 624 of file AdminCreateUserRequest.h.

◆ SetMessageAction() [1/2]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetMessageAction ( const MessageActionType value)
inline

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.

Definition at line 662 of file AdminCreateUserRequest.h.

◆ SetMessageAction() [2/2]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetMessageAction ( MessageActionType &&  value)
inline

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.

Definition at line 670 of file AdminCreateUserRequest.h.

◆ SetTemporaryPassword() [1/3]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetTemporaryPassword ( Aws::String &&  value)
inline

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.

Definition at line 528 of file AdminCreateUserRequest.h.

◆ SetTemporaryPassword() [2/3]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetTemporaryPassword ( const Aws::String value)
inline

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.

Definition at line 514 of file AdminCreateUserRequest.h.

◆ SetTemporaryPassword() [3/3]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetTemporaryPassword ( const char *  value)
inline

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.

Definition at line 542 of file AdminCreateUserRequest.h.

◆ SetUserAttributes() [1/2]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetUserAttributes ( Aws::Vector< AttributeType > &&  value)
inline

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.

Definition at line 258 of file AdminCreateUserRequest.h.

◆ SetUserAttributes() [2/2]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetUserAttributes ( const Aws::Vector< AttributeType > &  value)
inline

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.

Definition at line 229 of file AdminCreateUserRequest.h.

◆ SetUsername() [1/3]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetUsername ( Aws::String &&  value)
inline

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.

Definition at line 113 of file AdminCreateUserRequest.h.

◆ SetUsername() [2/3]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetUsername ( const Aws::String value)
inline

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.

Definition at line 106 of file AdminCreateUserRequest.h.

◆ SetUsername() [3/3]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetUsername ( const char *  value)
inline

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.

Definition at line 120 of file AdminCreateUserRequest.h.

◆ SetUserPoolId() [1/3]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool where the user will be created.

Definition at line 64 of file AdminCreateUserRequest.h.

◆ SetUserPoolId() [2/3]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool where the user will be created.

Definition at line 59 of file AdminCreateUserRequest.h.

◆ SetUserPoolId() [3/3]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetUserPoolId ( const char *  value)
inline

The user pool ID for the user pool where the user will be created.

Definition at line 69 of file AdminCreateUserRequest.h.

◆ SetValidationData() [1/2]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetValidationData ( Aws::Vector< AttributeType > &&  value)
inline

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.

Definition at line 423 of file AdminCreateUserRequest.h.

◆ SetValidationData() [2/2]

void Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::SetValidationData ( const Aws::Vector< AttributeType > &  value)
inline

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.

Definition at line 411 of file AdminCreateUserRequest.h.

◆ TemporaryPasswordHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::TemporaryPasswordHasBeenSet ( ) const
inline

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.

Definition at line 500 of file AdminCreateUserRequest.h.

◆ UserAttributesHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::UserAttributesHasBeenSet ( ) const
inline

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.

Definition at line 200 of file AdminCreateUserRequest.h.

◆ UsernameHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::UsernameHasBeenSet ( ) const
inline

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.

Definition at line 99 of file AdminCreateUserRequest.h.

◆ UserPoolIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::UserPoolIdHasBeenSet ( ) const
inline

The user pool ID for the user pool where the user will be created.

Definition at line 54 of file AdminCreateUserRequest.h.

◆ ValidationDataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::ValidationDataHasBeenSet ( ) const
inline

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.

Definition at line 399 of file AdminCreateUserRequest.h.

◆ WithClientMetadata() [1/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithClientMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 900 of file AdminCreateUserRequest.h.

◆ WithClientMetadata() [2/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithClientMetadata ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 874 of file AdminCreateUserRequest.h.

◆ WithDesiredDeliveryMediums() [1/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithDesiredDeliveryMediums ( Aws::Vector< DeliveryMediumType > &&  value)
inline

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.

Definition at line 729 of file AdminCreateUserRequest.h.

◆ WithDesiredDeliveryMediums() [2/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithDesiredDeliveryMediums ( const Aws::Vector< DeliveryMediumType > &  value)
inline

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.

Definition at line 722 of file AdminCreateUserRequest.h.

◆ WithForceAliasCreation()

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithForceAliasCreation ( bool  value)
inline

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.

Definition at line 637 of file AdminCreateUserRequest.h.

◆ WithMessageAction() [1/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithMessageAction ( const MessageActionType value)
inline

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.

Definition at line 678 of file AdminCreateUserRequest.h.

◆ WithMessageAction() [2/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithMessageAction ( MessageActionType &&  value)
inline

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.

Definition at line 686 of file AdminCreateUserRequest.h.

◆ WithTemporaryPassword() [1/3]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithTemporaryPassword ( Aws::String &&  value)
inline

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.

Definition at line 570 of file AdminCreateUserRequest.h.

◆ WithTemporaryPassword() [2/3]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithTemporaryPassword ( const Aws::String value)
inline

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.

Definition at line 556 of file AdminCreateUserRequest.h.

◆ WithTemporaryPassword() [3/3]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithTemporaryPassword ( const char *  value)
inline

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.

Definition at line 584 of file AdminCreateUserRequest.h.

◆ WithUserAttributes() [1/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithUserAttributes ( Aws::Vector< AttributeType > &&  value)
inline

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.

Definition at line 316 of file AdminCreateUserRequest.h.

◆ WithUserAttributes() [2/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithUserAttributes ( const Aws::Vector< AttributeType > &  value)
inline

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.

Definition at line 287 of file AdminCreateUserRequest.h.

◆ WithUsername() [1/3]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithUsername ( Aws::String &&  value)
inline

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.

Definition at line 134 of file AdminCreateUserRequest.h.

◆ WithUsername() [2/3]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithUsername ( const Aws::String value)
inline

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.

Definition at line 127 of file AdminCreateUserRequest.h.

◆ WithUsername() [3/3]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithUsername ( const char *  value)
inline

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.

Definition at line 141 of file AdminCreateUserRequest.h.

◆ WithUserPoolId() [1/3]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool where the user will be created.

Definition at line 79 of file AdminCreateUserRequest.h.

◆ WithUserPoolId() [2/3]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool where the user will be created.

Definition at line 74 of file AdminCreateUserRequest.h.

◆ WithUserPoolId() [3/3]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithUserPoolId ( const char *  value)
inline

The user pool ID for the user pool where the user will be created.

Definition at line 84 of file AdminCreateUserRequest.h.

◆ WithValidationData() [1/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithValidationData ( Aws::Vector< AttributeType > &&  value)
inline

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.

Definition at line 447 of file AdminCreateUserRequest.h.

◆ WithValidationData() [2/2]

AdminCreateUserRequest& Aws::CognitoIdentityProvider::Model::AdminCreateUserRequest::WithValidationData ( const Aws::Vector< AttributeType > &  value)
inline

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.

Definition at line 435 of file AdminCreateUserRequest.h.


The documentation for this class was generated from the following file: