https://github.com/rahulpsd18/cognito-backup-restore
AIO Tool for backing up and restoring AWS Cognito User Pools
https://github.com/rahulpsd18/cognito-backup-restore
amazon-cognito aws aws-cognito backup backup-cli cognito cognito-user-pool restore typescript
Last synced: 6 months ago
JSON representation
AIO Tool for backing up and restoring AWS Cognito User Pools
- Host: GitHub
- URL: https://github.com/rahulpsd18/cognito-backup-restore
- Owner: rahulpsd18
- License: mit
- Created: 2018-06-21T04:47:54.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-09T13:31:48.000Z (over 3 years ago)
- Last Synced: 2025-11-16T15:05:33.021Z (8 months ago)
- Topics: amazon-cognito, aws, aws-cognito, backup, backup-cli, cognito, cognito-user-pool, restore, typescript
- Language: TypeScript
- Homepage:
- Size: 3.54 MB
- Stars: 201
- Watchers: 11
- Forks: 65
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-aws - rahulpsd18/cognito-backup-restore :fire: - Tool for backing up and restoring Cognito user pools. (Open Source Repos / Cognito)
- awesome-aws - rahulpsd18/cognito-backup-restore :fire: - Tool for backing up and restoring Cognito user pools. (Open Source Repos / Cognito)
- awesome-aws - rahulpsd18/cognito-backup-restore :fire::fire: :hourglass: - Tool for backing up and restoring Cognito user pools. (Open Source Repos / Cognito)
README
# cognito-backup-restore
[](#contributors)
AIO Tool for backing up and restoring AWS Cognito User Pools
Amazon Cognito is awesome, but has its own set of limitations. Currently there is no backup option provided in case we need to take backup of users (to move to another service) or restore them to new Userpool.
`cognito-backup-restore` tries to overcome this problem by providing a way to backup users from cognito pool(s) to json file and vice-versa.
> **Please Note:** *There is no way of getting passwords of the users in cognito, so you may need to ask them to make use of ForgotPassword to recover their account.*
## Requirements
Requires node 6.10 or newer
## Installation
`cognito-backup-restore` is available as a package on [npm](https://www.npmjs.com/package/cognito-backup-restore).
```shell
npm install -g cognito-backup-restore
```
## Usage
`cognito-backup-restore` can be used by importing it directly or via [CLI](#cli) (recommended).
### Imports
Make sure you have installed it locally `npm install --save cognito-backup-restore`. Typings are available and included.
```typescript
import * as AWS from 'aws-sdk';
import {backupUsers, restoreUsers} from 'cognito-backup-restore';
const cognitoISP = new AWS.CognitoIdentityServiceProvider();
// you may use async-await too
backupUsers(cognitoISP, , )
.then(() => console.log(`Backup completed`))
.catch(console.error)
restoreUsers(cognitoISP, , , )
.then(() => console.log(`Restore completed`))
.catch(console.error)
```
This is useful incase you want to write your own wrapper or script instead of using CLI.
### CLI
Run `cognito-backup-restore` or `cbr` to use it. Make use of `-h` for help.
```shell
cbr [options]
```
> Available options are:
>
> `--region` `-r`: The region to use. Overrides config/env settings
>
> `--userpool` `--pool`: The Cognito pool to use. Possible value of `all` is allowed in case of backup.
>
> `--profile` `-p`: Use a specific profile from the credential file. Key and Secret can be passed instead (see below).
>
> `--aws-access-key` `--key`: The AWS Access Key to use. Not to be passed when using `--profile`.
>
> `--aws-secret-key` `--secret`: The AWS Secret Key to use. Not to be passed when using `--profile`.
>
> `--delay`: delay in millis between alternate users batch(60) backup, to avoid rate limit error.
>
> `--use-env-vars`: Use AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN (optional) as environment variables
>
> `--use-ec2-metadata`: Use credentials received from the metadata service on an EC2 instance
- **Backup**
```shell
cbr backup
cbr backup
```
`--directory` option is available to export json data to.
- **Restore**
```shell
cbr restore
cbr restore
```
`--file` option is available to read the json file to import from.
`--pwd` option is available to set TemporaryPassword of the users. If not provided, cognito generated password will be used and email will be sent to the users with One Time Password.
`--pwdModule` option is available to make use of custom logic to generate password. If not provided, cognito generated password will be used and email will be sent to the users with One Time Password, unless `--pwd` is used. Make sure to pass absolute path of the file. Refer [this](https://github.com/rahulpsd18/cognito-backup-restore/pull/1).
**In case any of the required option is missing, a interactive command line user interface kicks in to select from.**
## Todo
- [X] ~~Fine tune the backup process~~
- [X] ~~Implement Restore~~
- [X] ~~Write detailed Readme with examples~~
- [ ] Convert JSON to CSV
- [ ] Implement Amazon Cognito User Pool Import Job
- [ ] AWS Cross-Region Cognito Replication
## Contributors
Thanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):
adityamedhe-cc
📖 💻
juno-visualsquares
💻 🤔
Charlie Brown
🐛
Alvaro Del Valle
💬
Vlad Korolev
💻
ashish kumar
📖 💻
ufoo68
💻
steveizzle
📖 💻
M. Holger
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!