Skip to content

Commit

Permalink
docs: updated readme with IAM permissions (#122)
Browse files Browse the repository at this point in the history
* docs: updated readme with IAM permissions

* docs: fixed typo

* docs: language fix
  • Loading branch information
karl-cardenas-coding authored Feb 24, 2024
1 parent d467f63 commit 341578b
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,38 @@ $ glc clean -r us-east-1 -p myProfile -l custom_list.yaml
glc clean -r us-east-1 -p myProfile -l custom_list.json
```


### IAM Permissions

go-lambda-cleanup requires the following IAM permissions to operate.

- `lambda:ListFunctions`
- `lambda:ListVersionsByFunction`
- `lambda:ListAliases`
- `lambda:DeleteFunction`

The following code snippet is an IAM policy you may assign to the IAM User or IAM Role used by go-lambda-cleanup.


```json
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "goLambdaCleanup",
"Effect": "Allow",
"Action": [
"lambda:ListFunctions",
"lambda:ListVersionsByFunction",
"lambda:ListAliases",
"lambda:DeleteFunction"
],
"Resource": "*"
}
]
}
```

### Authentication
go-lambda-clean utilizes the default AWS Go SDK credentials provider to find AWS credentials. The default provider chain looks for credentials in the following order:

Expand Down Expand Up @@ -230,7 +262,7 @@ $ glc clean -r us-west-2
## Proxy
The tool supports network proxy configurations and will honor the following proxy environment variables.

* `HTTP_PROXY`,
* `HTTP_PROXY`
* `HTTPS_PROXY`
* `NO_PROXY`

Expand Down

0 comments on commit 341578b

Please sign in to comment.