Cognito Module¶
Description¶
This module creates a Cognito User Pool and User Pool Client.
Usage¶
module "user_cognito" {
source = "./modules/cognito"
product = "oqtopus"
org = "example"
env = "dev"
identifier = "user"
}
Requirements¶
| Name | Version |
|---|---|
| terraform | >= 1.9.0, < 2.0.0 |
| aws | ~> 5.57.0 |
Providers¶
| Name | Version |
|---|---|
| aws | ~> 5.57.0 |
Resources¶
| Name | Type |
|---|---|
| aws_cognito_user_pool.this | resource |
| aws_cognito_user_pool_client.this | resource |
Inputs¶
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| enable_delete_protection | Should enable Cognito userpool delete protection? | bool |
false |
no |
| enable_mfa | Should enable Cognito userpool MFA configuration? | bool |
true |
no |
| env | environment name | string |
n/a | yes |
| identifier | identifier | string |
n/a | yes |
| org | organization name | string |
n/a | yes |
| password_minimum_length | The minimum length of password | number |
8 |
no |
| product | product name | string |
n/a | yes |
| username_attributes | The Cognito userpool username attributes | list(string) |
[] |
no |
| userpool_auto_verified_attributes | The Cognito Userpool settings of automaatically verified attrobutes | list(string) |
[ |
no |
Outputs¶
| Name | Description |
|---|---|
| user_pool_arn | The ARN of the user pool |
| user_pool_id | The ID of the user pool |
| user_pool_web_client_id | The client ID of the user Cognito |