From 3f63b831793d48891b7973be0e07b17a38356a2e Mon Sep 17 00:00:00 2001 From: Toni de la Fuente Date: Tue, 27 Jul 2021 15:12:14 +0200 Subject: [PATCH] Added section with info about regions --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 57d04e6b..727b7242 100644 --- a/README.md +++ b/README.md @@ -185,6 +185,12 @@ Prowler has been written in bash using AWS-CLI and it works in Linux and OSX. Valid check numbers are based on the AWS CIS Benchmark guide, so 1.1 is check11 and 3.10 is check310 +### Regions + +By default Prowler scans all opt-in regions available, that might take a long execution time depending on the number of resources and regions used. Same applies for GovCloud or China regions. See below Advance usage for examples. + +Prowler has to parameters related to regions: `-r` that is used query AWS services API endpoints (it uses `us-east-1` by default and required for GovCloud or China) and the option `-f` that is to filter those regions you only want to scan. For example if you want to scan Dublin only use `-f eu-west-1` and if you want to scan Dublin and Ohio `-f 'eu-west-1 us-east-s'`, note the single quotes and space between regions. + ## Screenshots - Sample screenshot of report first lines: