Skip to content

Commit 87fff65

Browse files
committed
Update readme to include config/credentials file env vars
1 parent aa62c4a commit 87fff65

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,16 @@ depending on service gems.**
3636

3737
## Configuration
3838

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

4445
The SDK searches the following locations for credentials:
4546

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

0 commit comments

Comments
 (0)