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:

$sel:userPoolTags: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.

$sel:verificationMessageTemplate: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:emailVerificationMessage:CreateUserPool', createUserPool_emailVerificationMessage - A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.

$sel:smsAuthenticationMessage:CreateUserPool', createUserPool_smsAuthenticationMessage - A string representing the SMS authentication message.

$sel:userPoolAddOns:CreateUserPool', createUserPool_userPoolAddOns - Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

$sel:emailVerificationSubject:CreateUserPool', createUserPool_emailVerificationSubject - A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.

$sel:usernameAttributes:CreateUserPool', createUserPool_usernameAttributes - Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

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

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

$sel:accountRecoverySetting:CreateUserPool', createUserPool_accountRecoverySetting - Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

$sel:emailConfiguration:CreateUserPool', createUserPool_emailConfiguration - The email configuration.

$sel:smsVerificationMessage:CreateUserPool', createUserPool_smsVerificationMessage - A string representing the SMS verification message.

$sel:mfaConfiguration:CreateUserPool', createUserPool_mfaConfiguration - Specifies MFA configuration details.

$sel:lambdaConfig: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 will need to 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 .

$sel:smsConfiguration:CreateUserPool', createUserPool_smsConfiguration - The SMS configuration.

$sel:adminCreateUserConfig:CreateUserPool', createUserPool_adminCreateUserConfig - The configuration for AdminCreateUser requests.

$sel:deviceConfiguration:CreateUserPool', createUserPool_deviceConfiguration - The device configuration.

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

$sel:policies:CreateUserPool', createUserPool_policies - The policies associated with the new user pool.

$sel:usernameConfiguration:CreateUserPool', createUserPool_usernameConfiguration - You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

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

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.

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

A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.

A string representing the SMS authentication message.

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

A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

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

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

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

The email configuration.

A string representing the SMS verification message.

Specifies MFA configuration details.

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 will need to 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 .

The SMS configuration.

The configuration for AdminCreateUser requests.

The device configuration.

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

The policies associated with the new user pool.

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

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.