Skip to content

Commit

Permalink
docs(README): add information about other CLI arguments that can be p…
Browse files Browse the repository at this point in the history
…assed related to your AWS account
  • Loading branch information
Alex-ley committed Aug 30, 2021
1 parent 19ace9f commit 7fb0e76
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,18 @@ If you have AWS credits on your account and want to see them taken into account
--credits_remaining="xxx.xx"
```

## Other Useful CLI Arguments Related to your AWS account

With none of the folling arguments passed (--aws_account, --aws_profile, --aws_region), sensible defaults are attempted to be retrieved. For example, boto3 is used to try and determine your AWS account alias if it exists, and if not your AWS account ID. Additionally, for your AWS profile the environment variable AWS_PROFILE is read and used if present, otherwise fallback to 'default'. Finally, for your AWS region the environment variables AWS_REGION, then AWS_DEFAULT_REGION are read and used if present, otherwise fallback to 'us-east-1' (N. Virginia). However, if you supply one of these arguments when executing the `deploy` or `invoke` command, then these values are taken and no defaults are attempted to be retrieved:

```
serverless deploy \
--slack_url="https://hooks.slack.com/services/xxx/yyy/zzzz" \
--aws_account="my custom account name" \
--aws_profile="default" \
--aws_region="eu-west-1"
```

## Authors

- [Alex Ley](https://github.com/Alex-ley)
Expand Down

0 comments on commit 7fb0e76

Please sign in to comment.