Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 2.49 KB

README.md

File metadata and controls

74 lines (54 loc) · 2.49 KB
Raw

awsu - Switch-user for AWS

Introduction

Sometimes you find the need to switch roles on AWS from the command-line. While this is possible using the aws cli, it's quite cumbersome:

ASSUME=$(aws sts assume-role --role-arn "${TARGET_ACCOUNT_ROLE}" --role-session-name="awsu-bash")
export AWS_ACCESS_KEY_ID=$(echo "$ASSUME" | jq -r '.Credentials.AccessKeyId')
export AWS_SECRET_ACCESS_KEY=$(echo "$ASSUME" | jq -r '.Credentials.SecretAccessKey')
export AWS_SESSION_TOKEN=$(echo "$ASSUME" | jq -r '.Credentials.SessionToken')

Furthermore, depending on the duration of your tokens, they may expire before you're finished using them.

AWSU is designed to handle this for you, including performing token renewals at 80% of the token's lifetime.

Quickstart

Assume a role by name:

$ awsu superman bash
2021/06/08 16:10:07 Running bash with assumedRole arn:aws:iam::468901978831:role/superman, renewal in 47m
$

Or assume a role by ARN:

$ awsu arn:aws:iam::468901978831:role/superman <command>
2021/06/08 16:10:07 Running bash with assumedRole arn:aws:iam::468901978831:role/superman, renewal in 47m
$

Usage

Usage: awsu <role-arn> <command> ...

Arguments:
  <role-arn>
  <command> ...

Flags:
  -h, --help                                   Show context-sensitive help.
  -s, --session-name="awsu"                    Session name of the role to assume
  -e, --external-id=STRING                     ExternalID to authenticate the request
  -d, --duration=3600                          Duration of the session
  -v, --verbose                                Verbose error logging
  -t, --session-tags=KEY=VALUE;...             Session tags to apply to the role-assumption (eg: -t tag1=batman)
  -x, --transitive-tags=TRANSITIVE-TAGS,...    Keys for session tags which are transitive (eg: -x tag1)
  -i, --source-identity=STRING                 Source identity to set for this session

License

Copyright 2022 Square Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.