
Security News
Create React App Officially Deprecated Amid React 19 Compatibility Issues
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.
cognito-backup-restore
Advanced tools
AIO Tool for backing up and restoring AWS Cognito User Pools
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.
Requires node 6.10 or newer
cognito-backup-restore
is available as a package on npm.
npm install -g cognito-backup-restore
cognito-backup-restore
can be used by importing it directly or via CLI (recommended).
Make sure you have installed it locally npm install --save cognito-backup-restore
. Typings are available and included.
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, <USERPOOL-ID>, <directory>)
.then(() => console.log(`Backup completed`))
.catch(console.error)
restoreUsers(cognitoISP, <USERPOOL-ID>, <JSON-File>, <Password?>)
.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.
Run cognito-backup-restore
or cbr
to use it. Make use of -h
for help.
cbr <command> [options]
Available options are:
--region
-r
: The region to use. Overrides config/env settings
--userpool
--pool
: The Cognito pool to use. Possible value ofall
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
cbr backup
cbr backup <options>
--directory
option is available to export json data to.
Restore
cbr restore
cbr restore <options>
--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.
In case any of the required option is missing, a interactive command line user interface kicks in to select from.
Thanks goes to these wonderful people (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 specification. Contributions of any kind welcome!
FAQs
AIO Tool for backing up and restoring AWS Cognito User Pools
The npm package cognito-backup-restore receives a total of 1,481 weekly downloads. As such, cognito-backup-restore popularity was classified as popular.
We found that cognito-backup-restore demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.
Security News
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.