Skip to content

Commit

Permalink
Update AWS README.md (#35)
Browse files Browse the repository at this point in the history
* Update README.md
  • Loading branch information
ryanjpayne authored Dec 19, 2023
1 parent 60d93bc commit ac2c6a1
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion AWS/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ This script is a read-only utility that counts cloud resources in your AWS accou

No changes will be made to your account. No data will be sent anywhere and will remain in your cloud shell environment.

## How it works
This script can run against an individual AWS account or all child accounts in an AWS Organization. When running the script in CloudShell, it will establish the session using the AWS Identity currently signed in. When running the script in your local environment, it will establish the session based on your AWS CLI configuration. Please see [Local Environment Instructions](../README.md) for more details. If your AWS Identity is in the AWS Organization Management account, the script will use the default role `OrganizationAccountAccessRole` (or custom role if provided) to switch into each child account. If your AWS Identity is not in an AWS Organization Management account, the script will only process resources in this single account. Upon completion, a CSV report is generated with the findings.

## How to use

### Initialize execution environment
Expand All @@ -18,7 +21,7 @@ Open AWS Cloud Shell ([overview](https://aws.amazon.com/cloudshell/), [documenta
| eu-west-1 | **[Ireland](https://eu-west-1.console.aws.amazon.com/cloudshell/home?region=eu-west-1)** |
| ap-northeast-1 | **[Tokyo, Japan](https://ap-northeast-1.console.aws.amazon.com/cloudshell/home?region=ap-northeast-1)** |

### Run the script
### Example

```shell
curl https://raw.githubusercontent.com/CrowdStrike/cloud-resource-estimator/main/benchmark.sh | bash
Expand All @@ -29,3 +32,9 @@ curl https://raw.githubusercontent.com/CrowdStrike/cloud-resource-estimator/main
```shell
cat ./cloud-benchmark/*benchmark.csv
```

### Provide Custom IAM Role Name

```shell
export AWS_ASSUME_ROLE_NAME="custom-role-name"
```

0 comments on commit ac2c6a1

Please sign in to comment.