Represents the request to create a user pool.

See: newCreateUserPool smart constructor.

Create a value of CreateUserPool with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateUserPool, createUserPool_accountRecoverySetting - The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

CreateUserPool, createUserPool_adminCreateUserConfig - The configuration for AdminCreateUser requests.

CreateUserPool, createUserPool_aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

CreateUserPool, createUserPool_autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.

CreateUserPool, createUserPool_deletionProtection - When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

CreateUserPool, createUserPool_deviceConfiguration - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

CreateUserPool, createUserPool_emailConfiguration - The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

CreateUserPool, createUserPool_emailVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.

CreateUserPool, createUserPool_emailVerificationSubject - This parameter is no longer used. See VerificationMessageTemplateType.

CreateUserPool, createUserPool_lambdaConfig - The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the CLI, see add-permission .

CreateUserPool, createUserPool_mfaConfiguration - Specifies MFA configuration details.

CreateUserPool, createUserPool_policies - The policies associated with the new user pool.

$sel:schema:CreateUserPool', createUserPool_schema - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

CreateUserPool, createUserPool_smsAuthenticationMessage - A string representing the SMS authentication message.

CreateUserPool, createUserPool_smsConfiguration - The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

CreateUserPool, createUserPool_smsVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.

CreateUserPool, createUserPool_userAttributeUpdateSettings - The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

CreateUserPool, createUserPool_userPoolAddOns - Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

CreateUserPool, createUserPool_userPoolTags - The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

CreateUserPool, createUserPool_usernameAttributes - Specifies whether a user can use an email address or phone number as a username when they sign up.

CreateUserPool, createUserPool_usernameConfiguration - Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

CreateUserPool, createUserPool_verificationMessageTemplate - The template for the verification message that the user sees when the app requests permission to access the user's information.

$sel:poolName:CreateUserPool', createUserPool_poolName - A string used to name the user pool.

The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

The configuration for AdminCreateUser requests.

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

The attributes to be auto-verified. Possible values: email, phone_number.

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

This parameter is no longer used. See VerificationMessageTemplateType.

This parameter is no longer used. See VerificationMessageTemplateType.

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the CLI, see add-permission .

Specifies MFA configuration details.

The policies associated with the new user pool.

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

A string representing the SMS authentication message.

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

This parameter is no longer used. See VerificationMessageTemplateType.

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Specifies whether a user can use an email address or phone number as a username when they sign up.

Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

The template for the verification message that the user sees when the app requests permission to access the user's information.

A string used to name the user pool.

Represents the response from the server for the request to create a user pool.

See: newCreateUserPoolResponse smart constructor.

Create a value of CreateUserPoolResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userPool:CreateUserPoolResponse', createUserPoolResponse_userPool - A container for the user pool details.

$sel:httpStatus:CreateUserPoolResponse', createUserPoolResponse_httpStatus - The response's http status code.

A container for the user pool details.

The response's http status code.