aws cognito-idp create-user-pool
Creates a new Amazon Cognito user pool and sets the password policy for the pool
Options
| Name | Description |
|---|---|
--pool-name <string> | A string used to name the user pool |
--policies <structure> | The policies associated with the new user pool |
--lambda-config <structure> | 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 AWS CLI, see add-permission |
--auto-verified-attributes <list> | The attributes to be auto-verified. Possible values: email, phone_number |
--alias-attributes <list> | Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username |
--username-attributes <list> | Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up |
--sms-verification-message <string> | A string representing the SMS verification message |
--email-verification-message <string> | A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER |
--email-verification-subject <string> | A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER |
--verification-message-template <structure> | The template for the verification message that the user sees when the app requests permission to access the user's information |
--sms-authentication-message <string> | A string representing the SMS authentication message |
--mfa-configuration <string> | Specifies MFA configuration details |
--device-configuration <structure> | The device configuration |
--email-configuration <structure> | The email configuration |
--sms-configuration <structure> | The SMS configuration |
--user-pool-tags <map> | 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 |
--admin-create-user-config <structure> | The configuration for AdminCreateUser requests |
--schema <list> | An array of schema attributes for the new user pool. These attributes can be standard or custom attributes |
--user-pool-add-ons <structure> | Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT" |
--username-configuration <structure> | 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 |
--account-recovery-setting <structure> | 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 |
--cli-input-json <string> | Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally |
--generate-cli-skeleton <string> | Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command |