{"_id":"@boillodmanuel/aws-cognito-backup-restore","name":"@boillodmanuel/aws-cognito-backup-restore","dist-tags":{"latest":"0.4.0"},"versions":{"0.4.0":{"name":"@boillodmanuel/aws-cognito-backup-restore","version":"0.4.0","bin":{"cognito-backup":"bin/cognito-backup.js"},"repository":{"type":"git","url":"git+ssh://git@github.com/boillodmanuel/aws-cognito-backup-restore.git"},"scripts":{"getVersion":"node -e \"console.log(require('./package.json').version)\"","format":"prettier --write \"{bin,lib,test}/**/*.ts\"","lint":"eslint . --ext .ts","build":"npm run lint","preversion":"npm run format && npm run build","version":"version-changelog CHANGELOG.md && changelog-verify CHANGELOG.md && git add CHANGELOG.md","postversion":"git push && git push --tags","watch":"tsc -w","test":"jest","cdk":"cdk"},"devDependencies":{"@types/jest":"^29.4.0","@types/node":"18.13.0","@typescript-eslint/eslint-plugin":"^5.54.1","@typescript-eslint/parser":"^5.54.1","aws-cdk":"^2.66.1","changelog-verify":"^1.1.2","esbuild":"^0.17.11","eslint":"^8.35.0","eslint-config-prettier":"^8.7.0","jest":"^29.4.2","prettier":"^2.8.4","ts-jest":"^29.0.5","ts-node":"^10.9.1","typescript":"~4.9.5","version-changelog":"^3.1.1"},"dependencies":{"aws-cdk-lib":"2.66.1","constructs":"^10.1.269","source-map-support":"^0.5.21"},"gitHead":"d56ca6456df2f4252c559b6f676a6630cbf79ab5","description":"## Functional Overview","bugs":{"url":"https://github.com/boillodmanuel/aws-cognito-backup-restore/issues"},"homepage":"https://github.com/boillodmanuel/aws-cognito-backup-restore#readme","_id":"@boillodmanuel/aws-cognito-backup-restore@0.4.0","_nodeVersion":"16.19.1","_npmVersion":"8.19.3","dist":{"integrity":"sha512-eExNkaNeesRS66O83jwXvzRLILkyngfMyxX0CEhtVWPWWoRcY3lDyHK37cfKHWy5yBsjvMdSp2Z0Pc/YzwHBhQ==","shasum":"0f1c71325bbe4847a2c464d6ffde8975f6b44f33","tarball":"https://registry.npmjs.org/@boillodmanuel/aws-cognito-backup-restore/-/aws-cognito-backup-restore-0.4.0.tgz","fileCount":32,"unpackedSize":35161,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDnGE3GO3zf3+7lrH5tUgT6eaN2OzK1BRhySc6VhwqoaQIhANBojE2m8CB2wh2d0hPu3wGL42QPnM8JmjWGPqlna4yW"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkB4j2ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqAIQ/5AEEuj5S7QOvEEriYm17AyTjqLu9i/51y5Q8BzYTbARLxLHvm\r\n1UFD4zoOOHYkLasMzjUts7BAdw5uhyZieJcpfkwHeofXWLKnNTSYqaZ9B3J9\r\nK+YykCeSi6lLMT8MBb1dOfKBp58mGb5dzhFtZWcNruzIla9C7mrKNChp5xKy\r\nRHCCWBrQcfrq7qmYb/CZ54R5M1RtufUqSQklqNOv/q02rwcU/V0Xp9KtvL/H\r\nR8aoihWjChTh6Ywe0HleOZqbMnQkXo2BmBDp5L4vXH1PX4KnyEQsr6b4K2Zw\r\nluAWZzFRX1GWg8vdZ0TWcfmYKwnx7BNylzr/mnVoZ7B3c4sMWRea1zR/rrLy\r\nLj504slTnqK37j1AwyyPWJPGDRUa1D4ZRwnReVJ5DEZ2YRXYYgTmPyZLFjxN\r\nTNGRYg3enjTaaHmbTMawrn0Vdfgk/6YMhv7/7BcjkgSEkFQm1W7Taqx7vIK6\r\nBVilFPXS7LE9a88Ybred237NPEqYEbTbyqqji0W/CilmjCKIKUQd0RQNu2Ue\r\ndacyVSO6pG5M/VQC01vvT3UC/8qYEAPnI0aUwkqEHjbk8vRO0+z2JTQ2TGLr\r\noNaQFUx9BEeiu9QxNTCyxCTp/V49ouaMl0YoME0THIPcRhprPuUXKpf8iVRO\r\np+1ASWu6aTzDzsbcqsfbg1O/QsNy4cCKfiY=\r\n=TcyH\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"boillodmanuel","email":"manuel.b.public@gmail.com"},"directories":{},"maintainers":[{"name":"boillodmanuel","email":"manuel.b.public@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aws-cognito-backup-restore_0.4.0_1678215414273_0.5326254395540841"},"_hasShrinkwrap":false}},"time":{"created":"2023-03-07T18:56:54.181Z","0.4.0":"2023-03-07T18:56:54.472Z","modified":"2023-03-07T18:56:54.651Z"},"maintainers":[{"name":"boillodmanuel","email":"manuel.b.public@gmail.com"}],"description":"## Functional Overview","homepage":"https://github.com/boillodmanuel/aws-cognito-backup-restore#readme","repository":{"type":"git","url":"git+ssh://git@github.com/boillodmanuel/aws-cognito-backup-restore.git"},"bugs":{"url":"https://github.com/boillodmanuel/aws-cognito-backup-restore/issues"},"readme":"# Cognito Backup\n\n## Functional Overview\n\nThe Cognito backup extracts users and groups from cognito and copy it into a s3 bucket.\nIt runs everyday and create a daily and monthly backup.\n\nBackup details:\n- daily exports are kept for 30 days. Filename: `Cognito/DailyBackup/YYYY-MM-DD.json`\n- monthly exports are kept for 1 year. Filename: `Cognito/MonthlyBackup/YYYY-DD.json`\n\n\n## Technical overview\n\n- The backup is done by the `cognito-backup-function` lambda function\n- An EventBridge rule, scheduled every day, triggers the lambda function\n- The function extracts data (users and groups) from the cognito user pool and upload it into the S3 bucket\n\n\n## Installation\n\nPre-requisites:\n- `npm` installed\n- `AWS CDK` installed\n\nDeploy resources\n```bash\nnpm install\ncdk deploy\n```\n\n## Clean up\n\n\nTo clean-up resources\n```bash\nnpm install\ncdk destroy\n```\n\nDue to `removalPolicy`, somes resources are not deleted. Check cloud formation or source code ([lib/cognito-backup-stack.ts](./lib/cognito-backup-stack.ts)) to get the details.\n\n# Cognito Restoration\n\nThe restoration is manual.\n\nSee corresponding documentation in [the function README](./assets/cognito-backup-function/README.md).\n","readmeFilename":"README.md"}