[![cloudcomponents Logo](https://raw.githubusercontent.com/cloudcomponents/cdk-constructs/master/logo.png)](https://github.com/cloudcomponents/cdk-constructs)
# @cloudcomponents/cdk-deletable-bucket
[![Build Status](https://github.com/cloudcomponents/cdk-constructs/workflows/Build/badge.svg)](https://github.com/cloudcomponents/cdk-constructs/actions?query=workflow=Build)
[![cdkdx](https://img.shields.io/badge/buildtool-cdkdx-blue.svg)](https://github.com/hupe1980/cdkdx)
[![typescript](https://img.shields.io/badge/jsii-typescript-blueviolet.svg)](https://www.npmjs.com/package/@cloudcomponents/cdk-deletable-bucket)
[![python](https://img.shields.io/badge/jsii-python-blueviolet.svg)](https://pypi.org/project/cloudcomponents.cdk-deletable-bucket/)
> Bucket with content cleanup to allow bucket deletion when the stack will be destroyed
## Install
TypeScript/JavaScript:
```bash
npm i @cloudcomponents/cdk-deletable-bucket
```
Python:
```bash
pip install cloudcomponents.cdk-deletable-bucket
```
## How to use
```python
import { DeletableBucket } from '@cloudcomponents/cdk-deletable-bucket';
import { Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
export class DeletableBucketStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
new DeletableBucket(this, 'DeletableBucket', {
bucketName: 'bucket2delete',
forceDelete: true,
});
}
}
```
## API Reference
See [API.md](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-deletable-bucket/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-deletable-bucket/LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/cloudcomponents/cdk-constructs",
"name": "cloudcomponents.cdk-deletable-bucket",
"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/67/11/03de5b545e9c1f38deed0358460b4a466275eacc089455a6cd7bf9f85af5/cloudcomponents.cdk-deletable-bucket-2.3.0.tar.gz",
"platform": null,
"description": "[![cloudcomponents Logo](https://raw.githubusercontent.com/cloudcomponents/cdk-constructs/master/logo.png)](https://github.com/cloudcomponents/cdk-constructs)\n\n# @cloudcomponents/cdk-deletable-bucket\n\n[![Build Status](https://github.com/cloudcomponents/cdk-constructs/workflows/Build/badge.svg)](https://github.com/cloudcomponents/cdk-constructs/actions?query=workflow=Build)\n[![cdkdx](https://img.shields.io/badge/buildtool-cdkdx-blue.svg)](https://github.com/hupe1980/cdkdx)\n[![typescript](https://img.shields.io/badge/jsii-typescript-blueviolet.svg)](https://www.npmjs.com/package/@cloudcomponents/cdk-deletable-bucket)\n[![python](https://img.shields.io/badge/jsii-python-blueviolet.svg)](https://pypi.org/project/cloudcomponents.cdk-deletable-bucket/)\n\n> Bucket with content cleanup to allow bucket deletion when the stack will be destroyed\n\n## Install\n\nTypeScript/JavaScript:\n\n```bash\nnpm i @cloudcomponents/cdk-deletable-bucket\n```\n\nPython:\n\n```bash\npip install cloudcomponents.cdk-deletable-bucket\n```\n\n## How to use\n\n```python\nimport { DeletableBucket } from '@cloudcomponents/cdk-deletable-bucket';\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport { Construct } from 'constructs';\n\nexport class DeletableBucketStack extends Stack {\n constructor(scope: Construct, id: string, props?: StackProps) {\n super(scope, id, props);\n\n new DeletableBucket(this, 'DeletableBucket', {\n bucketName: 'bucket2delete',\n forceDelete: true,\n });\n }\n}\n```\n\n## API Reference\n\nSee [API.md](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-deletable-bucket/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-deletable-bucket/LICENSE)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Bucket with content cleanup to allow bucket deletion when the stack will be destroyed",
"version": "2.3.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": "76802be928a03ae6dc621e083fab36f3f3ae3e05ee8656c7dfab327b1e164462",
"md5": "d6d805f7142001d6a0df0e0f1091a3a1",
"sha256": "9deaedab9ac96e82ec4b83cd8be29e39d01a4b477c565ff391404b50d97b0bfc"
},
"downloads": -1,
"filename": "cloudcomponents.cdk_deletable_bucket-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6d805f7142001d6a0df0e0f1091a3a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 1339265,
"upload_time": "2024-04-17T18:36:35",
"upload_time_iso_8601": "2024-04-17T18:36:35.297825Z",
"url": "https://files.pythonhosted.org/packages/76/80/2be928a03ae6dc621e083fab36f3f3ae3e05ee8656c7dfab327b1e164462/cloudcomponents.cdk_deletable_bucket-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "671103de5b545e9c1f38deed0358460b4a466275eacc089455a6cd7bf9f85af5",
"md5": "88da5e069955d174866fd53dd409b6ca",
"sha256": "8549caa7bac7fcc6fa194680aa39112ad3ec05809d4d98f8261a6de475d3cfc6"
},
"downloads": -1,
"filename": "cloudcomponents.cdk-deletable-bucket-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "88da5e069955d174866fd53dd409b6ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 1340677,
"upload_time": "2024-04-17T18:36:42",
"upload_time_iso_8601": "2024-04-17T18:36:42.353843Z",
"url": "https://files.pythonhosted.org/packages/67/11/03de5b545e9c1f38deed0358460b4a466275eacc089455a6cd7bf9f85af5/cloudcomponents.cdk-deletable-bucket-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 18:36:42",
"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-deletable-bucket"
}