@cfn-modules/cognito-userpool

Cognito User Pool

Usage no npm install needed!

<script type="module">
  import cfnModulesCognitoUserpool from 'https://cdn.skypack.dev/@cfn-modules/cognito-userpool';
</script>

README

Build Status NPM version

cfn-modules: Amazon Cognito User Pool

An Amazon Cognito User Pool with domain and client.

Install

Install Node.js and npm first!

npm i @cfn-modules/cognito-userpool

Usage

---
AWSTemplateFormatVersion: '2010-09-09'
Description: 'cfn-modules example'
Resources:
  Queue:
    Type: 'AWS::CloudFormation::Stack'
    Properties:
      Parameters:
        InitialUser: 'hello@widdix.de' # optional
      TemplateURL: './node_modules/@cfn-modules/cognito-userpool/module.yml'

Parameters

Name Description Default Required? Allowed values
InitialUser The email address for initial user (temporary password via email). no Valid email address

Limitations

  • Secure: Does not backup/snapshot the users stored in the user pool.

Migration Guides

Migrate to v2

We are replacing a custom resource with the newly added AWS::Cognito::UserPoolDomain. Therefore, we need to change the randomly generated domain name.

  1. Temporary disable the CognitoUserPoolModule from all ecs-alb-target modules. Alternatively, you can also delete all stacks containing the ecs-alb-target module.
  2. Upgrade to version 2.0.0 of cognito-userpool.
  3. Enable the CognitoUserPoolModule from all ecs-alb-target modules.