Skip to content

Commit

Permalink
docs: update readme with new input parameter
Browse files Browse the repository at this point in the history 
Signed-off-by: Carlos Salas <carlos.salas@suse.com>
  • Loading branch information
@salasberryfin
salasberryfin committed Feb 29, 2024
1 parent 648a870 commit a78f59d
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,19 @@ A GitHub Action to cleanup AWS resources that have exceeded a TTL.
It supports cleaning up the following services:

- CloudFormation Stacks
- EKS Clusters
- Auto Scaling Groups

## Inputs

| Name | Required | Description |
| ----------------- | -------- | -------------------------------------------------------------------------------------- |
| regions | Y | A comma seperated list of regions to clean resources in. You can use * for all regions |
| allow-all-regions | N | Set to true if use * from regions. |
| ttl | Y | The duration that a resource can live for. For example, use 24h for 1 day. |
| commit | N | Whether to perform the delete. Defaults to `false` which is a dry run |
| Name | Required | Description |
| ----------------- | -------- | ------------------------------------------------------------------------------------------------- |
| regions | Y | A comma seperated list of regions to clean resources in. You can use * for all regions |
| ttl | Y | The duration that a resource can live for. For example, use 24h for 1 day. |
| allow-all-regions | N | Set to true if use * from regions. |
| commit | N | Whether to perform the delete. Defaults to `false` which is a dry run |
| ignore-tag | N | The name of the tag that indicates a resource should not be deleted. Defaults to `janitor-ignore` |

## Example Usage

Expand Down

0 comments on commit a78f59d

Please sign in to comment.