| account_recovery_mechanisms |
(Optional) A list of recovery_mechanisms which are defined by a name and its priority. Valid values for name are veri fied_email, verified_phone_number, and admin_only. |
any |
[] |
no |
| alias_attributes |
(Optional) Attributes supported as an alias for this user pool. Possible values: 'phone_number', 'email', or 'preferred_username'. Conflicts with username_attributes. |
set(string) |
null |
no |
| auto_verified_attributes |
(Optional) The attributes to be auto-verified. Possible values: 'email', 'phone_number'. |
set(string) |
[
"email"
] |
no |
| client_name |
(Required) The name of the client user pool. |
string |
n/a |
yes |
| domain |
(Optional) Type a domain prefix to use for the sign-up and sign-in pages that are hosted by Amazon Cognito, e.g. 'https://{YOUR_PREFIX}.auth.eu-west-1.amazoncognito.com'. The prefix must be unique across the selected AWS Region. Domain names can only contain lower-case letters, numbers, and hyphens. |
string |
null |
no |
| enable_username_case_sensitivity |
(Optional) Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs. |
bool |
false |
no |
| name |
(Required) The name of the user pool. |
string |
n/a |
yes |
| password_minimum_length |
(Optional) The minimum length of the password policy that you have set. |
number |
20 |
no |
| password_require_lowercase |
(Optional) Whether you have required users to use at least one lowercase letter in their password. |
bool |
true |
no |
| password_require_numbers |
(Optional) Whether you have required users to use at least one number in their password. |
bool |
true |
no |
| password_require_symbols |
(Optional) Whether you have required users to use at least one symbol in their password. |
bool |
true |
no |
| password_require_uppercase |
(Optional) Whether you have required users to use at least one uppercase letter in their password. |
bool |
true |
no |
| redirect_url |
Redirect URL. |
string |
null |
no |
| schema_attributes |
(Optional) A list of schema attributes of a user pool. You can add a maximum of 25 custom attributes. |
any |
[] |
no |
| tags |
(Optional) A mapping of tags to assign to the resource. |
map(string) |
{} |
no |
| temporary_password_validity_days |
(Optional) In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator. |
number |
1 |
no |