https://github.com/cruxstack/terraform-aws-cognito-userpool-clients

Terraform Module to provision Cognito userpool clients
https://github.com/cruxstack/terraform-aws-cognito-userpool-clients

aws cloudposse cognito cognito-idp cognito-user-pool oauth oauth2 sweetops terraform terraform-module

Last synced: 4 days ago
JSON representation

Terraform Module to provision Cognito userpool clients

• Host: GitHub
• URL: https://github.com/cruxstack/terraform-aws-cognito-userpool-clients
• Owner: cruxstack
• License: mit
• Created: 2023-08-05T20:06:04.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-02T18:17:25.000Z (about 1 year ago)
• Last Synced: 2024-11-20T21:30:46.221Z (2 months ago)
• Topics: aws, cloudposse, cognito, cognito-idp, cognito-user-pool, oauth, oauth2, sweetops, terraform, terraform-module
• Language: HCL
• Homepage: https://registry.terraform.io/modules/cruxstack/cognito-userpool-clients/aws/latest
• Size: 16.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Terraform Module: AWS Cognito Userpool Clients

This module creates and manages AWS Cognito User Pool Clients, allowing

fine-grained control over client configurations, UI customization, and secrets

management.

## Usage

```hcl

module "cognito_userpool_clients" {

  source  = "cruxstack/cognito-userpool-clients/aws"

  version = "x.x.x"

  userpool_id = ""

  client_defaults = {

    callback_urls = ["https://example.com/auth/"]

  }

  clients = {

    internal_web_app = {}

    public_web_app   = {}

    mobile_app       = {}

    foobar_service   = {}

  }

}

```

## Inputs

This module uses the `cloudposse/label/null` module for naming and tagging

resources. As such, it also includes a `context.tf` file with additional

optional variables you can set. Refer to the [`cloudposse/label` documentation](https://registry.terraform.io/modules/cloudposse/label/null/latest)

for more details on these variables.

| Name               | Description                                                           | Type                 | Default | Required |

|--------------------|-----------------------------------------------------------------------|----------------------|---------|----------|

| `userpool_id`      | Cognito user pool ID.                                                 | `string`             | `null`  | No       |

| `client_defaults`  | Default configurations for each client.                               | `object({...})`      | `{}`    | No       |

| `clients`          | Map of client-specific configurations. The key is the client name.    | `map(object({...}))` | `{}`    | No       |

| `secrets_enabled`  | Toggle to create SecretsManager secrets for each client.              | `bool`               | `true`  | No       |

| `aws_kv_namespace` | The namespace or prefix for AWS SSM parameters and similar resources. | `string`             | `""`    | No       |

## Outputs

| Name                  | Description                                                                                          |

|-----------------------|------------------------------------------------------------------------------------------------------|

| `clients`             | Map of Cognito user pool clients created by the module.                                              |

| `client_secret_names` | Map of the names of Secrets Manager secrets for the Cognito user pool clients, keyed by client name. |

## Contributing

We welcome contributions to this project. For information on setting up a

development environment and how to make a contribution, see [CONTRIBUTING](./CONTRIBUTING.md)

documentation.