Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs about :awscli credentials expiration #34

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve docs about :awscli credentials expiration #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## v2.3.0 - 2020-05-15

- Removed hardcoded `Poison` dependency, now uses configured `json_codec` within thP parent `ex_aws` module.
- Removed hardcoded `Poison` dependency, now uses configured `json_codec` within the parent `ex_aws` module.

## v2.2.0 - 2020-05-14

Expand Down
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,16 @@ When specified in your `~/.aws/config` you can set

```elixir
config :ex_aws,
secret_access_key: [{:awscli, "profile_name", 30}],
access_key_id: [{:awscli, "profile_name", 30}],
secret_access_key: [{:awscli, "profile_name", 1_800}],
access_key_id: [{:awscli, "profile_name", 1_800}],
awscli_auth_adapter: ExAws.STS.AuthCache.AssumeRoleCredentialsAdapter
```

and if the profile `profile_name` sets a `role_arn` then this will make ExAws
issue an `AssumeRoleCredentials` request to fetch the `access_key_id`
and `secret_access_key`.
The third element in the tuple (1_800 in the example) is the desired expiration in seconds.
[AWS enforces a minimum](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#API_AssumeRole_RequestParameters) of 900 seconds (15 minutes).

### Using AWS CLI config from ENV vars

Expand All @@ -57,8 +59,8 @@ In order to do that, just place in the config the block `awscli_credentials` wit

```elixir
config :ex_aws,
access_key_id: [{:awscli, "default", 30}],
secret_access_key: [{:awscli, "default", 30}],
access_key_id: [{:awscli, "default", 1_800}],
secret_access_key: [{:awscli, "default", 1_800}],
awscli_auth_adapter: ExAws.STS.AuthCache.AssumeRoleCredentialsAdapter,
awscli_credentials: %{
"default" => %{
Expand All @@ -79,8 +81,8 @@ Similarly, it is possible to use a web identity token to perform the assume role

```elixir
config :ex_aws,
secret_access_key: [{:awscli, "profile_name", 30}],
access_key_id: [{:awscli, "profile_name", 30}],
secret_access_key: [{:awscli, "profile_name", 1_800}],
access_key_id: [{:awscli, "profile_name", 1_800}],
awscli_auth_adapter: ExAws.STS.AuthCache.AssumeRoleWebIdentityAdapter
```

Expand Down