cloudcomponents.cdk-deletable-bucket

Name	cloudcomponents.cdk-deletable-bucket JSON
Version	2.4.0 JSON
	download
home_page	https://github.com/cloudcomponents/cdk-constructs
Summary	Bucket with content cleanup to allow bucket deletion when the stack will be destroyed
upload_time	2024-05-16 19:33:44
maintainer	None
docs_url	None
author	hupe1980
requires_python	~=3.8
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            [![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/33/22/24323096ecd4921db6ef34989df1698809c37c4e9f81edd1d23c1e757df6/cloudcomponents.cdk-deletable-bucket-2.4.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.4.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": "777c455181ad654041f3c223bb24a2f93b3602bf5602970bcebba199f766a0bd",
                "md5": "cfb89a064247614b9f6e01eb9c1b6e7f",
                "sha256": "34aaeac5ca6bdf75e7070ee7ae60c9e2bc9fad1dfad645cd7be0ebcf162b27bf"
            },
            "downloads": -1,
            "filename": "cloudcomponents.cdk_deletable_bucket-2.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cfb89a064247614b9f6e01eb9c1b6e7f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.8",
            "size": 140524,
            "upload_time": "2024-05-16T19:33:32",
            "upload_time_iso_8601": "2024-05-16T19:33:32.123290Z",
            "url": "https://files.pythonhosted.org/packages/77/7c/455181ad654041f3c223bb24a2f93b3602bf5602970bcebba199f766a0bd/cloudcomponents.cdk_deletable_bucket-2.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "332224323096ecd4921db6ef34989df1698809c37c4e9f81edd1d23c1e757df6",
                "md5": "5530a7667ae2a35c2c030760c098e82c",
                "sha256": "7ffa45449476327918293539ace359ce7cac9177428cc7ce5652f6acc461c002"
            },
            "downloads": -1,
            "filename": "cloudcomponents.cdk-deletable-bucket-2.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5530a7667ae2a35c2c030760c098e82c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.8",
            "size": 142042,
            "upload_time": "2024-05-16T19:33:44",
            "upload_time_iso_8601": "2024-05-16T19:33:44.535462Z",
            "url": "https://files.pythonhosted.org/packages/33/22/24323096ecd4921db6ef34989df1698809c37c4e9f81edd1d23c1e757df6/cloudcomponents.cdk-deletable-bucket-2.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-16 19:33:44",
    "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"
}