|
1 | 1 | # videoStreamer-users
|
2 | 2 | This is the terraform users module for my video streaming application
|
| 3 | + |
| 4 | +# TODO |
| 5 | +* Finish login functionality |
| 6 | +* Add password refresh |
| 7 | +* look into mfa |
| 8 | +* Figure out how to better leverage env's for stages |
| 9 | + |
| 10 | +<!-- BEGIN_TF_DOCS --> |
| 11 | +## Requirements |
| 12 | + |
| 13 | +| Name | Version | |
| 14 | +|------|---------| |
| 15 | +| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.1.8 | |
| 16 | +| <a name="requirement_archive"></a> [archive](#requirement\_archive) | ~> 2.2 | |
| 17 | +| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 4.11 | |
| 18 | + |
| 19 | +## Providers |
| 20 | + |
| 21 | +| Name | Version | |
| 22 | +|------|---------| |
| 23 | +| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.11.0 | |
| 24 | + |
| 25 | +## Modules |
| 26 | + |
| 27 | +| Name | Source | Version | |
| 28 | +|------|--------|---------| |
| 29 | +| <a name="module_acm"></a> [acm](#module\_acm) | terraform-aws-modules/acm/aws | ~> 3.0 | |
| 30 | +| <a name="module_api_gateway"></a> [api\_gateway](#module\_api\_gateway) | terraform-aws-modules/apigateway-v2/aws | ~> 1.7 | |
| 31 | +| <a name="module_api_log_group"></a> [api\_log\_group](#module\_api\_log\_group) | terraform-aws-modules/cloudwatch/aws//modules/log-group | ~> 3.0 | |
| 32 | +| <a name="module_confirm_register_lambda"></a> [confirm\_register\_lambda](#module\_confirm\_register\_lambda) | terraform-aws-modules/lambda/aws | ~> 3.1 | |
| 33 | +| <a name="module_register_lambda"></a> [register\_lambda](#module\_register\_lambda) | terraform-aws-modules/lambda/aws | ~> 3.1 | |
| 34 | + |
| 35 | +## Resources |
| 36 | + |
| 37 | +| Name | Type | |
| 38 | +|------|------| |
| 39 | +| [aws_cognito_user_pool.user_pool](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_pool) | resource | |
| 40 | +| [aws_cognito_user_pool_client.client](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_pool_client) | resource | |
| 41 | +| [aws_ssm_parameter.users_client_id](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource | |
| 42 | +| [aws_ssm_parameter.users_client_secret](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource | |
| 43 | +| [aws_ssm_parameter.users_pool_id](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource | |
| 44 | +| [aws_route53_zone.selected](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route53_zone) | data source | |
| 45 | + |
| 46 | +## Inputs |
| 47 | + |
| 48 | +| Name | Description | Type | Default | Required | |
| 49 | +|------|-------------|------|---------|:--------:| |
| 50 | +| <a name="input_env"></a> [env](#input\_env) | Environment; used for tagging and naming | `string` | `"dev"` | no | |
| 51 | +| <a name="input_project"></a> [project](#input\_project) | Project Name; used for tagging and naming | `string` | `"Auth"` | no | |
| 52 | +| <a name="input_project_key"></a> [project\_key](#input\_project\_key) | This will be used for subdomains and naming | `string` | `"auth"` | no | |
| 53 | +| <a name="input_zone_id"></a> [zone\_id](#input\_zone\_id) | The zone id used to create subdomains | `string` | n/a | yes | |
| 54 | + |
| 55 | +## Outputs |
| 56 | + |
| 57 | +| Name | Description | |
| 58 | +|------|-------------| |
| 59 | +| <a name="output_api_endpoint"></a> [api\_endpoint](#output\_api\_endpoint) | The API subdomain resource for authenticating users | |
| 60 | +<!-- END_TF_DOCS --> |
0 commit comments