diff options
| author | David Knaack <davidkna@users.noreply.github.com> | 2022-06-12 13:27:19 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-12 13:27:19 +0200 |
| commit | a72b4638f3d0463658175cdd1f05683fa2fa0d48 (patch) | |
| tree | 259bbecbaa2e946bd0bbc0c876b7a31f2fa33f62 /src | |
| parent | de9a5322ee37f4052247a6297a725fa14a272e66 (diff) | |
docs(aws): improve legibility (#4050)
Diffstat (limited to 'src')
| -rw-r--r-- | src/configs/aws.rs | 16 |
1 files changed, 5 insertions, 11 deletions
diff --git a/src/configs/aws.rs b/src/configs/aws.rs index 171fd76ff..7240d760c 100644 --- a/src/configs/aws.rs +++ b/src/configs/aws.rs @@ -6,17 +6,11 @@ use std::collections::HashMap; #[serde(default)] /// ## AWS /// -/// The `aws` module shows the current AWS region and profile when -/// credentials or a `credential_process` have been setup. This is based on -/// `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with -/// `~/.aws/config` file. This module also shows an expiration timer when using temporary -/// credentials. +/// The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. +/// The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. /// -/// The module will display a profile only if its credentials are present in -/// `~/.aws/credentials` or a `credential_process` is defined in -/// `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, -/// `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will -/// also suffice. +/// The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +/// If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. /// /// When using [aws-vault](https://github.com/99designs/aws-vault) the profile /// is read from the `AWS_VAULT` env var and the credentials expiration date @@ -25,7 +19,7 @@ use std::collections::HashMap; /// When using [awsu](https://github.com/kreuzwerker/awsu) the profile /// is read from the `AWSU_PROFILE` env var. /// -/// When using [`AWSume`](https://awsu.me) the profile +/// When using [AWSume](https://awsu.me) the profile /// is read from the `AWSUME_PROFILE` env var and the credentials expiration /// date is read from the `AWSUME_EXPIRATION` env var. pub struct AwsConfig<'a> { |