Skip to content

Commit bb74863

Browse files
committed
chore: update readme
1 parent 1937167 commit bb74863

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
<p align="center">
2-
<img src="logo.png" alt="vacuum" height="300px"/>
3-
</p>
1+
[![cdk-self-destruct](logo.png)](https://github.com/NimmLor/cdk-self-destruct)
42

5-
[![npm version](https://badge.fury.io/js/cdk-self-destruct.svg)](https://badge.fury.io/js/cdk-self-destruct)
3+
[![npm version](https://badge.fury.io/js/cdk-self-destruct.svg)](https://npmjs.com/package/cdk-self-destruct)
64
![Pipeline](https://github.com/NimmLor/cdk-self-destruct/actions/workflows/release.yml/badge.svg)
75

8-
A solid tool for destroying temporary CDK environments, which are commonly used in automated testing. With its scheduling feature for stack destruction, you can easily set a time and date or generate a url for the automatic removal of unnecessary stacks, freeing up resources and optimizing the testing workflow. It also removes resources that are impeding stack deletion, such as non-empty S3 buckets.
6+
A cdk construct for destroying CDK environments, which may be used in automated testing.
7+
8+
All resources in the stack may be set to be destroyed regardless of their `RemovalPolicy` or they may be retained.
9+
10+
With its scheduling feature for stack destruction, you can easily set a time and date or generate a url for the automatic removal of unnecessary stacks, freeing up resources and optimizing the testing workflow. It also removes resources that are impeding stack deletion, such as non-empty S3 buckets.
911

1012
Inspired by [cdk-time-bomb](https://github.com/jmb12686/cdk-time-bomb), rewritten with aws-cdk v2 and the new [AWS EventBridge Scheduler](https://aws.amazon.com/de/blogs/compute/introducing-amazon-eventbridge-scheduler).
1113

@@ -31,11 +33,7 @@ import { type Construct } from 'constructs'
3133
import { SelfDestruct } from 'cdk-self-destruct'
3234

3335
export class AwesomeStack extends Stack {
34-
public constructor(
35-
scope: Construct,
36-
id: string,
37-
props: StackProps
38-
) {
36+
public constructor(scope: Construct, id: string, props: StackProps) {
3937
super(scope, id, props)
4038

4139
new SelfDestruct(this, 'SelfDestruct', {
@@ -61,7 +59,7 @@ export class AwesomeStack extends Stack {
6159
- Purge S3 buckets before deletion
6260
- Stop all running state-machine executions
6361
- Delete automatically generated cloudwatch logs for lambda functions
64-
- *more coming soon*
62+
- _more coming soon_
6563
3. Schedule stack deletions after a given duration or at a given timestamp
6664
4. Create a [Lambda function URL](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) to delete the stack easily from the pipeline
6765

0 commit comments

Comments
 (0)