Metadata-Version: 2.1
Name: cdk-s3bucket
Version: 0.0.3
Summary: cdk-s3bucket
Home-page: https://github.com/guan840912/cdk-s3bucket.git
Author: Neil Kuan<guan840912@gmail.com>
License: Apache-2.0
Project-URL: Source, https://github.com/guan840912/cdk-s3bucket.git
Description: [![NPM version](https://badge.fury.io/js/cdk-s3bucket.svg)](https://badge.fury.io/js/cdk-s3bucket)
        [![PyPI version](https://badge.fury.io/py/cdk-s3bucket.svg)](https://badge.fury.io/py/cdk-s3bucket)
        ![Release](https://github.com/guan840912/cdk-s3bucket/workflows/Release/badge.svg)
        
        # cdk-s3bucket
        
        Create a S3 Bucket that can be deleted completely.
        
        # Why
        
        Sometime we just do some lab , create a S3 Bucket.
        Want to destroy resource , after Lab finished.
        But We forget delete Object in S3 Bucket first , so destroy will fail.
        
        `cdk-s3bucket`  can help delete object when cdk destroy , just add `removalPolicy: RemovalPolicy.DESTROY`  property .
        
        You never have to delete objects yourself, and the usage is almost the same as the native @aws-cdk/aws-s3.Bucket
        
        ## Now Try It !!!
        
        # Sample
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        from aws_cdk.core import App, Stack, CfnOutput, RemovalPolicy
        from cdk_s3bucket import Bucket
        
        # Create a S3 , add props "removalPolicy: RemovalPolicy.DESTROY".
        bucket = Bucket(stack, "Bucket",
            removal_policy=RemovalPolicy.DESTROY
        )
        
        # Get S3 Resource via bucket.s3Bucket ...
        CfnOutput(stack, "BucketName", value=bucket.s3_bucket.bucket_name)
        ```
        
        ### To deploy
        
        ```bash
        cdk deploy --require-approval never
        ```
        
        ### To destroy
        
        ```bash
        cdk destroy -f
        ```
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Typing :: Typed
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved
Requires-Python: >=3.6
Description-Content-Type: text/markdown
