Skip to content

Commit

Permalink
Mention the environment variables in the USAGE.md
Browse files Browse the repository at this point in the history
This PR documents the environment variables that can be used to override `aws-vault`'s defaults.
  • Loading branch information
wagdav authored Aug 13, 2018
1 parent ef7dc21 commit 635ece4
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,27 @@ then you can't use an AWS session, because AWS will return a 403 on the GetFeder
operation. That is when you'll use the less secure solution described above.


## Environment variables

The following environment variables can be set to override the default flag
values of `aws-vault` and its subcommands.

For the `aws-vault` command:

* `AWS_VAULT_BACKEND`: Secret backend to use (see the flag `--backend`)
* `AWS_VAULT_KEYCHAIN_NAME`: Name of macOS keychain to use (see the flag `--keychain`)
* `AWS_VAULT_PROMPT`: Prompt driver to use (see the flag `--prompt`)

For the `aws-vault exec` subcommand:

* `AWS_ASSUME_ROLE_TTL`: Expiration time for aws assumed role (see the flag `--assume-role-ttl)
* `AWS_SESSION_TTL`: Expiration time for aws session (see the flag `--session-ttl`)

For the `aws-vault login` subcommand:

* `AWS_FEDERATION_TOKEN_TTL`: Expiration time for aws console session (see the flag `--federation-token-ttl`)


## Example ~/.aws/config

Here is an example ~/.aws/config file, to help show the configuation. It defines two AWS accounts:
Expand Down

0 comments on commit 635ece4

Please sign in to comment.