[](https://github.com/cloudcomponents/cdk-constructs)
# @cloudcomponents/cdk-codecommit-backup
[](https://github.com/cloudcomponents/cdk-constructs/actions?query=workflow=Build)
[](https://github.com/hupe1980/cdkdx)
[](https://www.npmjs.com/package/@cloudcomponents/cdk-codecommit-backup)
[](https://pypi.org/project/cloudcomponents.cdk-codecommit-backup/)
[](https://github.com/kolomied/awesome-cdk)
> Backup CodeCommit repositories to S3
## Install
TypeScript/JavaScript:
```bash
npm i @cloudcomponents/cdk-codecommit-backup
```
Python:
```bash
pip install cloudcomponents.cdk-codecommit-backup
```
## How to use
```python
import { BackupBucket, S3CodeCommitBackup } from '@cloudcomponents/cdk-codecommit-backup';
import { Duration, Stack, StackProps } from 'aws-cdk-lib';
import { Repository } from 'aws-cdk-lib/aws-codecommit';
import { Schedule } from 'aws-cdk-lib/aws-events';
import { SnsTopic } from 'aws-cdk-lib/aws-events-targets';
import { Topic } from 'aws-cdk-lib/aws-sns';
import { EmailSubscription } from 'aws-cdk-lib/aws-sns-subscriptions';
import { Construct } from 'constructs';
export class CodeCommitBackupStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
if (typeof process.env.REPOSITORY_NAME === 'undefined') {
throw new Error('environment variable REPOSITORY_NAME undefined');
}
const repository = Repository.fromRepositoryName(this, 'Repository', process.env.REPOSITORY_NAME);
const backupBucket = new BackupBucket(this, 'BackupBuckt', {
retentionPeriod: Duration.days(90),
});
// The following example runs a task every day at 4am
const backup = new S3CodeCommitBackup(this, 'S3CodeCommitBackup', {
backupBucket,
repository,
schedule: Schedule.cron({
minute: '0',
hour: '4',
}),
});
const backupTopic = new Topic(this, 'BackupTopic');
if (process.env.DEVSECOPS_TEAM_EMAIL) {
backupTopic.addSubscription(new EmailSubscription(process.env.DEVSECOPS_TEAM_EMAIL));
}
backup.onBackupStarted('started', {
target: new SnsTopic(backupTopic),
});
backup.onBackupSucceeded('succeeded', {
target: new SnsTopic(backupTopic),
});
backup.onBackupFailed('failed', {
target: new SnsTopic(backupTopic),
});
}
}
```
## API Reference
See [API.md](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-codecommit-backup/API.md).
## Example
See more complete [examples](https://github.com/cloudcomponents/cdk-constructs/tree/master/examples).
## License
[MIT](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-codecommit-backup/LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/cloudcomponents/cdk-constructs",
"name": "cloudcomponents.cdk-codecommit-backup",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": null,
"author": "hupe1980",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/c7/ab/5adb75168955167530c470008abf63b841ab866010df29af16f8c5c7a6e9/cloudcomponents.cdk-codecommit-backup-2.2.0.tar.gz",
"platform": null,
"description": "[](https://github.com/cloudcomponents/cdk-constructs)\n\n# @cloudcomponents/cdk-codecommit-backup\n\n[](https://github.com/cloudcomponents/cdk-constructs/actions?query=workflow=Build)\n[](https://github.com/hupe1980/cdkdx)\n[](https://www.npmjs.com/package/@cloudcomponents/cdk-codecommit-backup)\n[](https://pypi.org/project/cloudcomponents.cdk-codecommit-backup/)\n[](https://github.com/kolomied/awesome-cdk)\n\n> Backup CodeCommit repositories to S3\n\n## Install\n\nTypeScript/JavaScript:\n\n```bash\nnpm i @cloudcomponents/cdk-codecommit-backup\n```\n\nPython:\n\n```bash\npip install cloudcomponents.cdk-codecommit-backup\n```\n\n## How to use\n\n```python\nimport { BackupBucket, S3CodeCommitBackup } from '@cloudcomponents/cdk-codecommit-backup';\nimport { Duration, Stack, StackProps } from 'aws-cdk-lib';\nimport { Repository } from 'aws-cdk-lib/aws-codecommit';\nimport { Schedule } from 'aws-cdk-lib/aws-events';\nimport { SnsTopic } from 'aws-cdk-lib/aws-events-targets';\nimport { Topic } from 'aws-cdk-lib/aws-sns';\nimport { EmailSubscription } from 'aws-cdk-lib/aws-sns-subscriptions';\nimport { Construct } from 'constructs';\n\nexport class CodeCommitBackupStack extends Stack {\n constructor(scope: Construct, id: string, props?: StackProps) {\n super(scope, id, props);\n\n if (typeof process.env.REPOSITORY_NAME === 'undefined') {\n throw new Error('environment variable REPOSITORY_NAME undefined');\n }\n const repository = Repository.fromRepositoryName(this, 'Repository', process.env.REPOSITORY_NAME);\n\n const backupBucket = new BackupBucket(this, 'BackupBuckt', {\n retentionPeriod: Duration.days(90),\n });\n\n // The following example runs a task every day at 4am\n const backup = new S3CodeCommitBackup(this, 'S3CodeCommitBackup', {\n backupBucket,\n repository,\n schedule: Schedule.cron({\n minute: '0',\n hour: '4',\n }),\n });\n\n const backupTopic = new Topic(this, 'BackupTopic');\n\n if (process.env.DEVSECOPS_TEAM_EMAIL) {\n backupTopic.addSubscription(new EmailSubscription(process.env.DEVSECOPS_TEAM_EMAIL));\n }\n\n backup.onBackupStarted('started', {\n target: new SnsTopic(backupTopic),\n });\n\n backup.onBackupSucceeded('succeeded', {\n target: new SnsTopic(backupTopic),\n });\n\n backup.onBackupFailed('failed', {\n target: new SnsTopic(backupTopic),\n });\n }\n}\n```\n\n## API Reference\n\nSee [API.md](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-codecommit-backup/API.md).\n\n## Example\n\nSee more complete [examples](https://github.com/cloudcomponents/cdk-constructs/tree/master/examples).\n\n## License\n\n[MIT](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-codecommit-backup/LICENSE)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Backup CodeCommit repositories to S3",
"version": "2.2.0",
"project_urls": {
"Homepage": "https://github.com/cloudcomponents/cdk-constructs",
"Source": "https://github.com/cloudcomponents/cdk-constructs.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b694ffad4da39c96bb1ffb0b89a272b29a8cd8f24a57f1987ec728d66024778e",
"md5": "00dbcd8288c173a2a157141d151851a2",
"sha256": "5e943d502ee4d4ef1232a4a108b52c16344a8834739f66e82ccfc763f5332aa8"
},
"downloads": -1,
"filename": "cloudcomponents.cdk_codecommit_backup-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "00dbcd8288c173a2a157141d151851a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 146833,
"upload_time": "2024-05-16T19:28:20",
"upload_time_iso_8601": "2024-05-16T19:28:20.277079Z",
"url": "https://files.pythonhosted.org/packages/b6/94/ffad4da39c96bb1ffb0b89a272b29a8cd8f24a57f1987ec728d66024778e/cloudcomponents.cdk_codecommit_backup-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c7ab5adb75168955167530c470008abf63b841ab866010df29af16f8c5c7a6e9",
"md5": "66a77a4aaa889c847210c2f71cc3a5ca",
"sha256": "1b3657d0c6bfc176f54c1d7bd0735ccd0f64bfd8e4ac24db666cf9d9a5dad07e"
},
"downloads": -1,
"filename": "cloudcomponents.cdk-codecommit-backup-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "66a77a4aaa889c847210c2f71cc3a5ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 148529,
"upload_time": "2024-05-16T19:28:24",
"upload_time_iso_8601": "2024-05-16T19:28:24.164494Z",
"url": "https://files.pythonhosted.org/packages/c7/ab/5adb75168955167530c470008abf63b841ab866010df29af16f8c5c7a6e9/cloudcomponents.cdk-codecommit-backup-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-16 19:28:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cloudcomponents",
"github_project": "cdk-constructs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cloudcomponents.cdk-codecommit-backup"
}
JSON
