You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
remove mention of isengard
remove mention of isengard
fixed dependency files
fixed dependency files
clean up dockerfile
clean up dockerfile
clean up dockerfile
Copy file name to clipboardExpand all lines: .tools/test/stacks/nuke/typescript/README.md
+3-7Lines changed: 3 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,20 @@
1
1
2
2
# aws-nuke for Weathertop
3
3
4
-
[aws-nuke](https://github.com/ekristen/aws-nuke) is an open-source tool that deletes resources in a provided AWS account that are not considered "Default" or "AWS-Managed".
5
-
6
-
This tool is implemented using the Cloud Development Kit (CDK) script in this directory which deploy the [official aws-nuke image](https://github.com/ekristen/aws-nuke/pkgs/container/aws-nuke) to an AWS Lambda function.
4
+
[aws-nuke](https://github.com/ekristen/aws-nuke) is an open-source tool that deletes non-default resources in a provided AWS account. It's implemented here in this directory using Cloud Development Kit (CDK) code that deploys the [official aws-nuke image](https://github.com/ekristen/aws-nuke/pkgs/container/aws-nuke) to an AWS Lambda function.
7
5
8
6
## ⚠ Important
9
7
This is a very destructive tool! It should not be deployed without fully understanding the impact it will have on your AWS accounts.
10
8
Please use caution and configure this tool to delete unused resources only in your lower test/sandbox environment accounts.
11
9
12
10
## Overview
13
11
14
-
Defined in [account_nuker.ts](account_nuker.ts), this CDK stack deploys an AWS Lambda function that runs in a Docker container, scheduled to execute weekly via EventBridge.
15
-
16
-
It includes:
12
+
This CDK stack is defined in [account_nuker.ts](account_nuker.ts). It includes:
17
13
- A Docker-based Lambda function with ARM64 architecture and 1GB memory
18
14
- An IAM role with administrative permissions for the Lambda's nuking function
19
15
- An EventBridge rule that triggers the function every Sunday at midnight
20
16
21
-
The Lambda function is built from a [Dockerfile](Dockerfile) and runs with a 15-minute timeout. It contains a [nuke_generic_config.yml](nuke_generic_config.yaml) config and executes a [run.sh](run.sh).
17
+
More specifically, this Lambda function is built from a [Dockerfile](Dockerfile) and runs with a 15-minute timeout. It contains a [nuke_generic_config.yml](nuke_generic_config.yaml) config and executes a [run.sh](run.sh) when invoked every Sunday at midnight UTC.
0 commit comments