|
| 1 | +<!-- BEGIN_TF_DOCS --> |
| 2 | +## Requirements |
| 3 | + |
| 4 | +No requirements. |
| 5 | + |
| 6 | +## Providers |
| 7 | + |
| 8 | +| Name | Version | |
| 9 | +|------|---------| |
| 10 | +| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.85.0 | |
| 11 | + |
| 12 | +## Modules |
| 13 | + |
| 14 | +No modules. |
| 15 | + |
| 16 | +## Resources |
| 17 | + |
| 18 | +| Name | Type | |
| 19 | +|------|------| |
| 20 | +| [aws_cognito_identity_provider.saml](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_identity_provider) | resource | |
| 21 | +| [aws_cognito_user_pool.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_pool) | resource | |
| 22 | +| [aws_cognito_user_pool_client.cognito](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_pool_client) | resource | |
| 23 | +| [aws_cognito_user_pool_client.saml](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_pool_client) | resource | |
| 24 | +| [aws_cognito_user_pool_domain.custom](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_pool_domain) | resource | |
| 25 | +| [aws_cognito_user_pool_domain.prefix](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_pool_domain) | resource | |
| 26 | +| [aws_cognito_user_pool_ui_customization.saml](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cognito_user_pool_ui_customization) | resource | |
| 27 | +| [aws_iam_role.cognito_user_pool_sms](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | |
| 28 | +| [aws_iam_role_policy.cognito_user_pool_sms](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource | |
| 29 | +| [aws_route53_record.alias_cognito_user_pool_domain_custom](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource | |
| 30 | +| [aws_iam_policy_document.cognito_user_pool_admin_get_user](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
| 31 | +| [aws_iam_policy_document.cognito_user_pool_assumerole](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
| 32 | +| [aws_iam_policy_document.cognito_user_pool_manage](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
| 33 | +| [aws_iam_policy_document.cognito_user_pool_read_create_entities](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
| 34 | +| [aws_iam_policy_document.sns_publish_any](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
| 35 | + |
| 36 | +## Inputs |
| 37 | + |
| 38 | +| Name | Description | Type | Default | Required | |
| 39 | +|------|-------------|------|---------|:--------:| |
| 40 | +| <a name="input_access_token_validity"></a> [access\_token\_validity](#input\_access\_token\_validity) | Access Token Validity | <pre>object({<br/> value = optional(number, 480)<br/> units = optional(string, "minutes")<br/> })</pre> | <pre>{<br/> "units": "minutes",<br/> "validity": 480<br/>}</pre> | no | |
| 41 | +| <a name="input_allowed_oauth_scopes"></a> [allowed\_oauth\_scopes](#input\_allowed\_oauth\_scopes) | Allowed OAuth Scopes for Cognito | `list(string)` | <pre>[<br/> "openid",<br/> "email",<br/> "profile"<br/>]</pre> | no | |
| 42 | +| <a name="input_app_fqdn"></a> [app\_fqdn](#input\_app\_fqdn) | Fully Qualified Domain Name for the App protected by Cognito | `string` | n/a | yes | |
| 43 | +| <a name="input_aws"></a> [aws](#input\_aws) | n/a | <pre>object({<br/> account_id = string<br/> default_tags = optional(map(string), {})<br/> partition = optional(string, "aws")<br/> region = string<br/> url_suffix = optional(string, "amazonaws.com")<br/> })</pre> | n/a | yes | |
| 44 | +| <a name="input_callback_urls"></a> [callback\_urls](#input\_callback\_urls) | Callback URLs for Cognito | `list(string)` | `[]` | no | |
| 45 | +| <a name="input_custom_domain"></a> [custom\_domain](#input\_custom\_domain) | Optional FQDN & Route53 Public Hosted Zone ID for a custom Cognito User Pool Domain | <pre>object({<br/> cloudfront_acm_certificate_arn = string<br/> fqdn = string<br/> route53_public_hosted_zone_id = string<br/> })</pre> | `null` | no | |
| 46 | +| <a name="input_explicit_auth_flows"></a> [explicit\_auth\_flows](#input\_explicit\_auth\_flows) | Explicit Auth Flows for Cognito | `list(string)` | <pre>[<br/> "ALLOW_USER_PASSWORD_AUTH",<br/> "ALLOW_USER_SRP_AUTH",<br/> "ALLOW_REFRESH_TOKEN_AUTH"<br/>]</pre> | no | |
| 47 | +| <a name="input_logout_urls"></a> [logout\_urls](#input\_logout\_urls) | Logout URLs for Cognito if logout\_urls\_are\_callback\_urls is false | `list(string)` | `[]` | no | |
| 48 | +| <a name="input_logout_urls_are_callback_urls"></a> [logout\_urls\_are\_callback\_urls](#input\_logout\_urls\_are\_callback\_urls) | Whether the Logout URLs are the same as the Callback URLs | `bool` | `true` | no | |
| 49 | +| <a name="input_module_parents"></a> [module\_parents](#input\_module\_parents) | List of parent module names | `list(string)` | `[]` | no | |
| 50 | +| <a name="input_saml_idp"></a> [saml\_idp](#input\_saml\_idp) | n/a | <pre>object({<br/> sso_metadata = object({<br/> url = optional(string, null) # "https://login.microsoftonline.com/<tenant_id>/federationmetadata/2007-06/federationmetadata.xml?appid=<app_id>"<br/> content = optional(string, null) # "<xml>...</xml>"<br/> })<br/><br/> ui_customisation = object({<br/> css = optional(string, ".label-customizable {font-weight: 400;}")<br/><br/> image = optional(object({<br/> base64 = optional(string, null)<br/> file = optional(string, null)<br/> }), null)<br/><br/> name = optional(string, null)<br/> })<br/> })</pre> | `null` | no | |
| 51 | +| <a name="input_unique_ids"></a> [unique\_ids](#input\_unique\_ids) | n/a | <pre>object({<br/> # All marked as optional for consistency of code.<br/> # Whether each is optional depends on the module implementation.<br/> local = optional(string, null)<br/> account = optional(string, null)<br/> global = optional(string, null)<br/> })</pre> | n/a | yes | |
| 52 | +| <a name="input_user_pool_domain_prefix"></a> [user\_pool\_domain\_prefix](#input\_user\_pool\_domain\_prefix) | Cognito User Pool Domain Prefix if not using a custom domain. Defaults to local.unique\_id | `string` | `null` | no | |
| 53 | + |
| 54 | +## Outputs |
| 55 | + |
| 56 | +| Name | Description | |
| 57 | +|------|-------------| |
| 58 | +| <a name="output_saml_parameters"></a> [saml\_parameters](#output\_saml\_parameters) | SAML Parameters | |
| 59 | +| <a name="output_user_pool"></a> [user\_pool](#output\_user\_pool) | n/a | |
| 60 | +| <a name="output_user_pool_client"></a> [user\_pool\_client](#output\_user\_pool\_client) | Client User Pool Client Secret | |
| 61 | +<!-- END_TF_DOCS --> |
0 commit comments