diff --git a/README.md b/README.md index d614acf..2305972 100644 --- a/README.md +++ b/README.md @@ -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