ghndrx/prowler
1
0
Fork 0
mirror of https://github.com/ghndrx/prowler.git synced 2026-02-10 14:55:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: format regions-and-partitions (#2371)

Browse Source
This commit is contained in:
Pepe Fagoaga
2023-05-18 16:35:54 +02:00
committed by GitHub
parent 8fbee7737b
commit 58a38c08d7
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/tutorials/aws/regions-and-partitions.md
View File

@@ -1,18 +1,20 @@
# AWS Regions and Partitions # AWS Regions and Partitions
By default Prowler is able to scan the following AWS partitions: By default Prowler is able to scan the following AWS partitions:
- Commercial: `aws` - Commercial: `aws`
- China: `aws-cn` - China: `aws-cn`
- GovCloud (US): `aws-us-gov` - GovCloud (US): `aws-us-gov`
> To check the available regions for each partition and service please refer to the following document [aws_regions_by_service.json](https://github.com/prowler-cloud/prowler/blob/master/prowler/providers/aws/aws_regions_by_service.json) > To check the available regions for each partition and service please refer to the following document [aws_regions_by_service.json](https://github.com/prowler-cloud/prowler/blob/master/prowler/providers/aws/aws_regions_by_service.json)
It is important to take into consideration that to scan the China (`aws-cn`) or GovCloud (`aws-us-gov`) partitions it is either required to have a valid region for that partition in your AWS credentials (Refer to https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials for more information) or to specify the regions you want to audit for that partition using the `-f/--region` flag. It is important to take into consideration that to scan the China (`aws-cn`) or GovCloud (`aws-us-gov`) partitions it is either required to have a valid region for that partition in your AWS credentials or to specify the regions you want to audit for that partition using the `-f/--region` flag.
> Please, refer to https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials for more information about the AWS credentials configuration.
You can get more information about the available partitions and regions in the following [Botocore](https://github.com/boto/botocore) file https://github.com/boto/botocore/blob/22a19ea7c4c2c4dd7df4ab8c32733cba0c7597a4/botocore/data/partitions.json You can get more information about the available partitions and regions in the following [Botocore](https://github.com/boto/botocore) [file](https://github.com/boto/botocore/blob/22a19ea7c4c2c4dd7df4ab8c32733cba0c7597a4/botocore/data/partitions.json).
## AWS China ## AWS China
To scan your AWS Account in the China partition (`aws-cn`): To scan your AWS account in the China partition (`aws-cn`):
- Using the `-f/--region` flag: - Using the `-f/--region` flag:
``` ```
@@ -30,7 +32,7 @@ region = cn-north-1
## AWS GovCloud (US) ## AWS GovCloud (US)
To scan your AWS Account in the GovCloud (US) partition (`aws-us-gov`): To scan your AWS account in the GovCloud (US) partition (`aws-us-gov`):
- Using the `-f/--region` flag: - Using the `-f/--region` flag:
``` ```
@@ -48,7 +50,7 @@ region = us-gov-east-1
## AWS ISO (US & Europe) ## AWS ISO (US & Europe)
For the AWS ISO partitions, which are known as "secret partitions" and are air-gapped from the internet there is no builtin way to scanned it. In this scenario if you want to audit an AWS Account in one of the AWS ISO partitions you should manually update the [aws_regions_by_service.json](https://github.com/prowler-cloud/prowler/blob/master/prowler/providers/aws/aws_regions_by_service.json) and include the partition, region and services, e.g.: For the AWS ISO partitions, which are known as "secret partitions" and are air-gapped from the Internet, there is no builtin way to scan it. If you want to audit an AWS account in one of the AWS ISO partitions you should manually update the [aws_regions_by_service.json](https://github.com/prowler-cloud/prowler/blob/master/prowler/providers/aws/aws_regions_by_service.json) and include the partition, region and services, e.g.:
```json ```json
"iam": { "iam": {
"regions": { "regions": {