1beac5958ede29855ef2ac4313ada83ed37f5ea8
- Author
- Rob Vadai <rvadai@segence.com>
- Committer
- GitHub <noreply@github.com>
- Date
Message
docs(aws): add config examples (#9422)
Diff
1diff --git a/plugins/aws/README.md b/plugins/aws/README.md
2index 4c2ae96e57340593acc0ddb6987fc7ba1b874a8b..011bbd8b4d382e01b59e0ad9882fee5e2807d1b7 100644
3--- a/plugins/aws/README.md
4+++ b/plugins/aws/README.md
5@@ -43,3 +43,33 @@ the current `$AWS_PROFILE`. It uses two variables to control how that is shown:
6 * ZSH_THEME_AWS_PREFIX: sets the prefix of the AWS_PROFILE. Defaults to `<aws:`.
7
8 * ZSH_THEME_AWS_SUFFIX: sets the suffix of the AWS_PROFILE. Defaults to `>`.
9+
10+## Configuration
11+
12+[Configuration and credential file settings](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) by AWS
13+
14+### Scenario: IAM roles with a source profile and MFA authentication
15+
16+Source profile credentials in `~/.aws/credentials`:
17+
18+```
19+[source-profile-name]
20+aws_access_key_id = ...
21+aws_secret_access_key = ...
22+```
23+
24+Role configuration in `~/.aws/config`:
25+
26+```
27+[profile source-profile-name]
28+mfa_serial = arn:aws:iam::111111111111:mfa/myuser
29+region = us-east-1
30+output = json
31+
32+[profile profile-with-role]
33+role_arn = arn:aws:iam::9999999999999:role/myrole
34+mfa_serial = arn:aws:iam::111111111111:mfa/myuser
35+source_profile = source-profile-name
36+region = us-east-1
37+output = json
38+```