Skip to content

Commit 634c00b

Browse files
committed
Improved/fixed some notes and instructions around the use of the env var AWS_DEFAULT_REGION.
Signed-off-by: Exadra37 <exadra37@gmail.com>
1 parent 7cf09dc commit 634c00b

File tree

2 files changed

+3
-9
lines changed

2 files changed

+3
-9
lines changed

docs/APPROOV_TOKEN_QUICKSTART.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The initial set of variables are specified in the next section, the others will
6969
7070
### Setup the Environment Variables
7171

72-
* `AWS_DEFAULT_REGION` - MUST be the same as configured at `~/.aws/config`. If you want to use another region then you need to add it to each command `--region ___AWS_REGION_HERE___`.
72+
* `AWS_DEFAULT_REGION` - This env var will override the region configured at `~/.aws/config` and will be used by several commands through this quickstart.
7373
* `AWS_ACCOUNT_ID` - MUST be your AWS account number. It can be retrieved with `aws sts get-caller-identity --query Account --output text`
7474
* `AWS_HTTP_API_ID` - The ID for the HTTP API you want to protect with Approov. It can be retrieved from the AWS CLI with `aws apigatewayv2 get-apis`.
7575
* `API_DOMAIN` - The domain for the API in the AWS API Gateway.
@@ -494,12 +494,6 @@ The AWS CLI does some encryption on the data it sends in their requests. The enc
494494

495495
For example, when using Windows 10 WSL2 with Ubuntu you may have problems if Ubuntu is using a different timezone to Windows, for example UTC+0 and UTC+1.
496496

497-
#### AWS Region
498-
499-
When your are asked to set the env var `AWS_DEFAULT_REGION` you MUST use the same value configured at `~/.aws/config` otherwise it will cause permissions issues.
500-
501-
If you don't want to change your `~/.aws/config` file and still use a different AWS region then you need to add the `--region ___AWS_DEFAULT_REGION_HERE___` to all AWS CLI commands you copy from this quickstart.
502-
503497
#### AWS Credentials
504498

505499
To use the AWS CLI you need to correctly configure the `~/.aws/credentials` file with the Access Key ID and the Secret Access Key for your IAM user.

docs/AWS_API_GATEWAY_EXAMPLE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ cd quickstart-aws-api-gateway-v2
9090

9191
### Setup Placeholders as Environment Variables
9292

93-
* `AWS_DEFAULT_REGION` - MUST be the same as configured at `~/.aws/config`.
93+
* `AWS_DEFAULT_REGION` - This env var will override the region configured at `~/.aws/config` and will be used by several commands through this example.
9494
* `AWS_ACCOUNT_ID` - MUST be your AWS account number. Use CLI command `aws sts get-caller-identity --query Account --output text` to print it if you are unsure.
9595

9696
#### Prepare the Env File
@@ -148,7 +148,7 @@ Output:
148148
Login Succeeded
149149
```
150150

151-
> **NOTE:** If your login doesn't succeed it's probably because the `AWS_DEFAULT_REGION` environment variable doesn't match the value you have at `~/.aws/config`.
151+
> **NOTE:** If your login doesn't succeed it's probably because you forgot to export the environment variables or their values aren't correct.
152152
153153

154154
#### Create the ECR Repository

0 commit comments

Comments
 (0)