# clean-aws

> CLI tool to clean AWS environments

Latest version **0.0.5** (published 2019-06-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install clean-aws
pnpm add clean-aws
yarn add clean-aws
bun add clean-aws
```

Provides the command `clean-aws`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2019-06-05 |
| First published | 2018-11-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.10.0 |
| Dependencies | 8 |
| Unpacked size | 132.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | rawphp |

## Links

- npm: https://www.npmjs.com/package/clean-aws
- Repository: https://github.com/rawphp/clean-aws
- Homepage: https://github.com/rawphp/clean-aws#readme
- Issues: https://github.com/rawphp/clean-aws/issues
- npm.io page: https://npm.io/package/clean-aws

## Dependencies (8)

- [colors](https://npm.io/package/colors.md) ^1.3.2
- [semver](https://npm.io/package/semver.md) ^5.6.0
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.363.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.3
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.1
- [commander](https://npm.io/package/commander.md) ^2.19.0
- [read-pkg-up](https://npm.io/package/read-pkg-up.md) ^4.0.0
- [prompt-confirm](https://npm.io/package/prompt-confirm.md) ^2.0.4

## Recent versions

- 0.0.5 (latest) — 2019-06-05
- 0.0.2 — 2018-11-27

## README

# Clean AWS

This tool can be used to clean up AWS environments.

## Install

```bash
npm install -g clean-aws
```

## Usage

If you want to delete all resources from your AWS account, you can just run `clean-aws clean`. This will delete all resources from all regions. You can also limit the tool to certain regions. Before deleting it will ask you to confirm that you indeed want to continue.

If you want to choose the resources to remove, then first run the `clean-aws list` command. Review the list of resources generated and remove the resources you want to keep from the list. Once you're happy to delete the reminder, run `clean-aws clean` passing the path to the resource file.

### List Resources

Running the list command will list all supported resources on an AWS environment. This list can then be used to tell the tool which resources to remove.

```bash
clean-aws list --profile default --region ap-southeast-2
```

### Remove Resources

This command will remove all resources listed in the resource file. If not provided, the tool will delete all resources found.

```bash
clean-aws clean --profile default --resourceFile ./resources.json
```

## Detail

This tool cleans (or plans to clean) the following AWS resources:

### Supported

- CloudFormation stacks
- S3 buckets
- CloudWatch logs
- DataPipeline
- DynamoDB tables
- EC2 Instances
- IAM Roles
- IAM Policies
- IAM Users
- SNS Topics
- SNS Topic Subscriptions
- SQS Queues

### Planned

- ELBs
- ES domains
- Route53 resources
- ElasticBeanstalk Applications
- ElasticBeanstalk Environments

## Use as a Library

This package can also be used as a library.

`TODO: Provide example`

## License

MIT

---
_Source: https://npm.io/package/clean-aws · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._