ylib/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-23 03:25:42 +08:00
Code Projects Releases Wiki Activity
3e6ee85a16
ohmyzsh/plugins/aws/README.md
Maksym 3e6ee85a16
fix(aws): support MFA for profiles without role to assume (#9411) 
Previously, the plugin only supported MFA for profiles that had a role to assume, specified in role_arn. Now, the plugin supports MFA for profiles without a role to assume.

Closes #9408

* refactor(aws plugin): remove dependency on jq

Previously, acp command relied on jq. Now that dependency has been removed, as well as some linter suggestions implemented.
2020-11-04 22:10:22 +01:00

1.9 KiB
Raw Blame History

aws

This plugin provides completion support for awscli
and a few utilities to manage AWS profiles and display them in the prompt.

To use it, add aws to the plugins array in your zshrc file.

plugins=(... aws)

Plugin commands

  • asp [<profile>]: sets $AWS_PROFILE and $AWS_DEFAULT_PROFILE (legacy) to <profile>.
    It also sets $AWS_EB_PROFILE to <profile> for the Elastic Beanstalk CLI.
    Run asp without arguments to clear the profile.

  • acp [<profile>]: in addition to asp functionality, it actually changes the profile by
    assuming the role specified in the <profile> configuration. It supports MFA and sets
    $AWS_ACCESS_KEY_ID, $AWS_SECRET_ACCESS_KEY and $AWS_SESSION_TOKEN, if obtained. It
    requires the roles to be configured as per the
    official guide.
    Run acp without arguments to clear the profile.

  • agp: gets the current value of $AWS_PROFILE.

  • aws_change_access_key: changes the AWS access key of a profile.

  • aws_profiles: lists the available profiles in the $AWS_CONFIG_FILE (default: ~/.aws/config).
    Used to provide completion for the asp function.

Plugin options

  • Set SHOW_AWS_PROMPT=false in your zshrc file if you want to prevent the plugin from modifying your RPROMPT.
    Some themes might overwrite the value of RPROMPT instead of appending to it, so they'll need to be fixed to
    see the AWS profile prompt.

Theme

The plugin creates an aws_prompt_info function that you can use in your theme, which displays
the current $AWS_PROFILE. It uses two variables to control how that is shown:

  • ZSH_THEME_AWS_PREFIX: sets the prefix of the AWS_PROFILE. Defaults to <aws:.

  • ZSH_THEME_AWS_SUFFIX: sets the suffix of the AWS_PROFILE. Defaults to >.