When it appears
It appears when AWS environment variables or configuration identify credentials, a profile, or a region.
Preview
Rendered from the starting configuration in a representative simulated environment.
starship — preview
on ☁️ prod ap-southeast-2 1h12m
Starting configuration
[aws]
format = "on [$symbol($profile )($region )($duration )]($style)"
style = "bold yellow"The configuration is compressed into the URL fragment and stays in your browser.
Key options
- formatstring
- The format for the module.
- symbolstring
- The symbol used before displaying the current AWS profile.
- stylestring
- The style for the module.
- force_displayboolean
- If true displays info even if credentials, credential_process or sso_start_url have not been setup.
- region_aliasesobject
- Table of region aliases to display in addition to the AWS name.
- profile_aliasesobject
- Table of profile aliases to display in addition to the AWS name.
- expiration_symbolstring
- The symbol displayed when the temporary credentials have expired.
Format variables
- $symbol
- Mirrors the value of option symbol
- $profile
- The current AWS profile
- $region
- The current AWS region
- $duration
- The temporary credentials validity duration
Common adjustments
- Use profile_aliases to replace long SSO profile names with recognisable labels.
- Use region_aliases when compact region names still remain unambiguous.
- Keep duration conditional so permanent credentials do not leave empty brackets.