Skip to content

Commit

Permalink
Update readme to include config/credentials file env vars
Browse files Browse the repository at this point in the history
  • Loading branch information
alextwoods committed Sep 23, 2024
1 parent aa62c4a commit 87fff65
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,16 @@ depending on service gems.**

## Configuration

You will need to configure credentials and a region, either in configuration
files or environment variables, to make API calls. It is recommended that you
You will need to configure credentials and a region, either in
[configuration files](https://docs.aws.amazon.com/sdkref/latest/guide/file-location.html)
or environment variables, to make API calls. It is recommended that you
provide these via your environment. This makes it easier to rotate credentials
and it keeps your secrets out of source control.
and it keeps your secrets out of source control.

The SDK searches the following locations for credentials:

* `ENV['AWS_ACCESS_KEY_ID']` and `ENV['AWS_SECRET_ACCESS_KEY']`
* The shared credentials ini file at `~/.aws/credentials`
* The shared credentials ini file at `~/.aws/credentials`. The location used can be changed with the `AWS_CREDENTIALS_FILE` ENV variable.
* Credential options supported in this file are:
* Static Credentials (`aws_access_key_id`, `aws_secret_access_key`, `aws_session_token`)
* Assume Role Web Identity Credentials (`web_identity_token_file`, `role_arn`, `source_profile`)
Expand Down

0 comments on commit 87fff65

Please sign in to comment.