This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_create_user_pool/ for full documentation.
cognitoidentityprovider_create_user_pool(
PoolName,
Policies = NULL,
DeletionProtection = NULL,
LambdaConfig = NULL,
AutoVerifiedAttributes = NULL,
AliasAttributes = NULL,
UsernameAttributes = NULL,
SmsVerificationMessage = NULL,
EmailVerificationMessage = NULL,
EmailVerificationSubject = NULL,
VerificationMessageTemplate = NULL,
SmsAuthenticationMessage = NULL,
MfaConfiguration = NULL,
UserAttributeUpdateSettings = NULL,
DeviceConfiguration = NULL,
EmailConfiguration = NULL,
SmsConfiguration = NULL,
UserPoolTags = NULL,
AdminCreateUserConfig = NULL,
Schema = NULL,
UserPoolAddOns = NULL,
UsernameConfiguration = NULL,
AccountRecoverySetting = NULL
)[required] A string used to name the user pool.
The policies associated with the new user pool.
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
delete_user_pool API
request, Amazon Cognito returns an InvalidParameterException error. To
delete a protected user pool, send a new
delete_user_pool request
after you deactivate deletion protection in an
update_user_pool API
request.
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 .
The attributes to be auto-verified. Possible values: email, phone_number.
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
Specifies whether a user can use an email address or phone number as a username when they sign up.
This parameter is no longer used. See VerificationMessageTemplateType.
This parameter is no longer used. See VerificationMessageTemplateType.
This parameter is no longer used. See VerificationMessageTemplateType.
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 SMS authentication message.
Specifies MFA configuration details.
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.
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.
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.
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 configuration for
admin_create_user
requests.
An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
User pool add-ons. Contains settings for activation of advanced security
features. To log user security information but take no action, set to
AUDIT. To configure automatic security responses to risky traffic to
your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool.
Case sensitivity on the username input for the selected sign-in option.
When case sensitivity is set to False (case insensitive), users can
sign in with any combination of capital and lowercase letters. For
example, username, USERNAME, or UserName, or for email,
email@example.com or EMaiL@eXamplE.Com. For most use cases, set case
sensitivity to False (case insensitive) as a best practice. When
usernames and email addresses are case insensitive, Amazon Cognito
treats any variation in case as the same user, and prevents a case
variation from being assigned to the same attribute for a different
user.
This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
The available verified method a user can use to recover their password
when they call
forgot_password. 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.