README.md

This component is responsible for provisioning and managing AWS Cognito resources.

This component can provision the following resources:

• Cognito User Pools
• Cognito User Pool Clients
• Cognito User Pool Domains
• Cognito User Pool Identity Providers
• Cognito User Pool Resource Servers
• Cognito User Pool User Groups
• Cognito Risk Configuration

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Usage

Stack Level: Global

Here's an example snippet for how to use this component:

components:
  terraform:
    cognito:
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        # The full name of the User Pool will be: <namespace>-<environment>-<stage>-<name>
        name: cognito
        schemas:
          - name: "email"
            attribute_data_type: "String"
            developer_only_attribute: false
            mutable: false
            required: true

Risk Configuration Examples

Basic Account Takeover Protection

components:
  terraform:
    cognito:
      vars:
        enabled: true
        name: cognito
        # Configure account takeover risk protection
        account_takeover_risk_configuration:
          notify_configuration:
            block_email:
              html_body: "Your account has been blocked due to suspicious activity."
              subject: "Account Security Alert"
              text_body: "Your account has been blocked due to suspicious activity."
            from: "security@[company].com"
            # Replace with your SES verified identity ARN for the correct region/account
            source_arn: "<SES_SOURCE_ARN>"  # e.g., arn:aws:ses:REGION:ACCOUNT:identity/email@domain.com
          actions:
            high_action:
              event_action: "BLOCK"
              notify: true
            medium_action:
              event_action: "MFA_REQUIRED"
              notify: true
            low_action:
              event_action: "NO_ACTION"
              notify: false

Compromised Credentials Detection

components:
  terraform:
    cognito:
      vars:
        enabled: true
        name: cognito
        # Configure compromised credentials detection
        compromised_credentials_risk_configuration:
          event_filter: ["SIGN_IN", "PASSWORD_CHANGE"]
          actions:
            event_action: "BLOCK"

IP-Based Risk Exceptions

components:
  terraform:
    cognito:
      vars:
        enabled: true
        name: cognito
        # Configure IP-based risk exceptions
        risk_exception_configuration:
          blocked_ip_range_list:
            - "192.0.2.0/24"    # Block this IP range
            - "203.0.113.0/24"  # Block this IP range
          skipped_ip_range_list:
            - "10.0.0.0/8"      # Skip risk detection for internal network
            - "172.16.0.0/12"   # Skip risk detection for private network

Client-Specific Risk Configuration

components:
  terraform:
    cognito:
      vars:
        enabled: true
        name: cognito
        clients:
          - name: "web-app"
            generate_secret: false
          - name: "mobile-app"
            generate_secret: true
        # Configure risk settings for specific clients
        # Note: client_id must be the actual App Client ID, not the client name
        risk_configurations:
          - client_id: "1a2b3c4d5e6f7g8h9i0j1k2l3m"  # Actual App Client ID for web-app
            account_takeover_risk_configuration:
              actions:
                high_action:
                  event_action: "BLOCK"
                  notify: false
                medium_action:
                  event_action: "MFA_IF_CONFIGURED"
                  notify: false
                low_action:
                  event_action: "NO_ACTION"
                  notify: false
          - client_id: "9z8y7x6w5v4u3t2s1r0q9p8o7n"  # Actual App Client ID for mobile-app
            compromised_credentials_risk_configuration:
              event_filter: ["SIGN_IN"]
              actions:
                event_action: "BLOCK"

Important: The client_id field requires the actual AWS Cognito App Client ID, not the client name. To reference the App Client ID from the module outputs, use module.cognito.client_ids_map["client-name"] where client-name is the name you defined in the clients configuration.

Comprehensive Risk Configuration

components:
  terraform:
    cognito:
      vars:
        enabled: true
        name: cognito
        # Comprehensive risk configuration with all features
        risk_configurations:
          - # Global User Pool configuration
            account_takeover_risk_configuration:
              notify_configuration:
                block_email:
                  html_body: "<h1>Security Alert</h1><p>Your account has been temporarily blocked due to suspicious activity.</p>"
                  subject: "Account Security Alert - Action Required"
                  text_body: "Your account has been temporarily blocked due to suspicious activity. Please contact support."
                mfa_email:
                  html_body: "<h1>Additional Verification Required</h1><p>We detected unusual activity and require additional verification.</p>"
                  subject: "Additional Verification Required"
                  text_body: "We detected unusual activity and require additional verification."
                no_action_email:
                  html_body: "<h1>Security Notice</h1><p>We detected some unusual activity but no action is required.</p>"
                  subject: "Security Notice"
                  text_body: "We detected some unusual activity but no action is required."
                from: "security@[company].com"
                reply_to: "noreply@[company].com"
                # Replace with your SES verified identity ARN for the correct region/account
                source_arn: "<SES_SOURCE_ARN>"  # e.g., arn:aws:ses:REGION:ACCOUNT:identity/email@domain.com
              actions:
                high_action:
                  event_action: "BLOCK"
                  notify: true
                medium_action:
                  event_action: "MFA_REQUIRED"
                  notify: true
                low_action:
                  event_action: "NO_ACTION"
                  notify: true
            compromised_credentials_risk_configuration:
              event_filter: ["SIGN_IN", "PASSWORD_CHANGE", "SIGN_UP"]
              actions:
                event_action: "BLOCK"
            risk_exception_configuration:
              blocked_ip_range_list:
                - "192.0.2.0/24"
                - "203.0.113.0/24"
              skipped_ip_range_list:
                - "10.0.0.0/8"
                - "172.16.0.0/12"
                - "192.168.0.0/16"

Using Module Outputs for Client IDs

When you need to reference App Client IDs from the same module (e.g., in a separate resource or data source), use the client_ids_map output:

# Example: Using the cognito module's client_ids_map output in another resource
components:
  terraform:
    cognito:
      vars:
        enabled: true
        name: cognito
        clients:
          - name: "web-app"
            generate_secret: false
          - name: "mobile-app"
            generate_secret: true

    # Separate resource that needs the client IDs
    cognito-risk-config:
      vars:
        user_pool_id: "${module.cognito.id}"
        web_app_client_id: "${module.cognito.client_ids_map['web-app']}"
        mobile_app_client_id: "${module.cognito.client_ids_map['mobile-app']}"

Requirements

Providers

Modules

Resources

Inputs

object({
    notify_configuration = optional(object({
      block_email = optional(object({
        html_body = optional(string)
        subject   = optional(string)
        text_body = optional(string)
      }))
      mfa_email = optional(object({
        html_body = optional(string)
        subject   = optional(string)
        text_body = optional(string)
      }))
      no_action_email = optional(object({
        html_body = optional(string)
        subject   = optional(string)
        text_body = optional(string)
      }))
      from       = optional(string)
      reply_to   = optional(string)
      source_arn = optional(string)
    }))
    actions = optional(object({
      high_action = optional(object({
        event_action = string
        notify       = optional(bool)
      }))
      medium_action = optional(object({
        event_action = string
        notify       = optional(bool)
      }))
      low_action = optional(object({
        event_action = string
        notify       = optional(bool)
      }))
    }))
  })

{
  "access_token": "minutes",
  "id_token": "minutes",
  "refresh_token": "days"
}

object({
    event_filter = optional(list(string))
    actions = optional(object({
      event_action = string
    }))
  })

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

[
  "default"
]

object({
    minimum_length                   = number,
    require_lowercase                = bool,
    require_numbers                  = bool,
    require_symbols                  = bool,
    require_uppercase                = bool,
    temporary_password_validity_days = number
  })

list(object({
    client_id   = optional(string)
    client_name = optional(string)
    account_takeover_risk_configuration = optional(object({
      notify_configuration = optional(object({
        block_email = optional(object({
          html_body = optional(string)
          subject   = optional(string)
          text_body = optional(string)
        }))
        mfa_email = optional(object({
          html_body = optional(string)
          subject   = optional(string)
          text_body = optional(string)
        }))
        no_action_email = optional(object({
          html_body = optional(string)
          subject   = optional(string)
          text_body = optional(string)
        }))
        from       = optional(string)
        reply_to   = optional(string)
        source_arn = optional(string)
      }))
      actions = optional(object({
        high_action = optional(object({
          event_action = string
          notify       = optional(bool)
        }))
        medium_action = optional(object({
          event_action = string
          notify       = optional(bool)
        }))
        low_action = optional(object({
          event_action = string
          notify       = optional(bool)
        }))
      }))
    }))
    compromised_credentials_risk_configuration = optional(object({
      event_filter = optional(list(string))
      actions = optional(object({
        event_action = string
      }))
    }))
    risk_exception_configuration = optional(object({
      blocked_ip_range_list = optional(list(string))
      skipped_ip_range_list = optional(list(string))
    }))
  }))

object({
    blocked_ip_range_list = optional(list(string))
    skipped_ip_range_list = optional(list(string))
  })

Outputs

Related Projects

Check out these related projects.

• Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
• Atmos - Atmos is like docker-compose but for your infrastructure

References

For additional context, refer to some of these links.

• cloudposse-terraform-components - Cloud Posse's upstream component

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Review our Code of Conduct and Contributor Guidelines.
2. Fork the repo on GitHub
3. Clone the project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your fork
6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Running Terraform Tests

We use Atmos to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.

All tests are located in the test/ folder.

Under the hood, tests are powered by Terratest together with our internal Test Helpers library, providing robust infrastructure validation.

Setup dependencies:

• Install Atmos (installation guide)
• Install Go 1.24+ or newer
• Install Terraform or OpenTofu

To run tests:

• Run all tests:

  atmos test run
  

• Clean up test artifacts:

  atmos test clean
  

• Explore additional test options:

  atmos test --help
  

The configuration for test commands is centrally managed. To review what's being imported, see the atmos.yaml file.

Learn more about our automated testing in our documentation or implementing custom commands with atmos.

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

Copyright © 2017-2026 Cloud Posse, LLC