https://github.com/b-b3rn4rd/awscli-console-plugin
AWSCLI plugin to access AWS Console using your IAM or STS credentials
https://github.com/b-b3rn4rd/awscli-console-plugin
aws awscli-plugin console golang sts-credentials
Last synced: 5 months ago
JSON representation
AWSCLI plugin to access AWS Console using your IAM or STS credentials
- Host: GitHub
- URL: https://github.com/b-b3rn4rd/awscli-console-plugin
- Owner: b-b3rn4rd
- License: mit
- Created: 2020-10-08T11:04:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-17T12:03:49.000Z (about 3 years ago)
- Last Synced: 2024-06-21T16:43:46.456Z (almost 2 years ago)
- Topics: aws, awscli-plugin, console, golang, sts-credentials
- Language: Go
- Homepage:
- Size: 246 KB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# awscli-console-plugin
[](https://goreportcard.com/report/github.com/b-b3rn4rd/awscli-console-plugin)
[](https://coveralls.io/github/b-b3rn4rd/awscli-console-plugin?branch=master)
[](https://github.com/b-b3rn4rd/awscli-console-plugin/actions?query=workflow%3AGo+branch%3Amaster)
AWSCLI plugin to access AWS Console using your IAM or STS credentials
# Demo
# Motivation
The following library is distributed as `awscli` plugin, but could be used a standalone tool to access AWS Console
using IAM access & secret keys or STS temporary credentials.
The code is based on the following article https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html
The goal of this plugin is to simplify the authentication process to AWS Console, by providing a method to login to a given account without leaving the terminal.
# Installation
To install it as a plugin for `awscli` please follow these steps
Install `awscli-console-plugin` using `pip`, use an appropriate artifact for your OS from the release page.
```bash
$ pip3 install https://github.com/b-b3rn4rd/awscli-console-plugin/releases/download/1.2.1/awscli-console-plugin_1.2.1_Darwin_x86_64.zip # MacOS
$ pip3 install https://github.com/b-b3rn4rd/awscli-console-plugin/releases/download/1.2.1/awscli-console-plugin_1.2.1_Linux_x86_64.zip # Linux
$ pip3 install https://github.com/b-b3rn4rd/awscli-console-plugin/releases/download/1.2.1/awscli-console-plugin_1.2.1_Windows_x86_64.zip # Windows
```
# Configuration
Edit your `~/.aws/config` to include the following plugin definition:
If you are using the v1 AWS CLI, you can just add the plugin:
```
[plugins]
console = console
[profile auth]
region=ap-southeast-2
aws_access_key_id=AKIAXXXXXXXXXXX
aws_secret_access_key=XYXYXYYXYXYXYXYXY/ZZZZZZ
[profile dev]
role_arn=arn:aws:iam::1234567890123:role/OrganizationAccountAccessRole
region=ap-southeast-2
source_profile=auth
```
If you are using the v2 AWS CLI, you need to also specify the `cli_legacy_plugin_path`, which should
specify where your `pip` packages are installed.
```
[plugins]
cli_legacy_plugin_path =
console = console
[profile auth]
region=ap-southeast-2
aws_access_key_id=AKIAXXXXXXXXXXX
aws_secret_access_key=XYXYXYYXYXYXYXYXY/ZZZZZZ
[profile dev]
role_arn=arn:aws:iam::1234567890123:role/OrganizationAccountAccessRole
region=ap-southeast-2
source_profile=auth
```
# Usage
Verify that the plugin is successfully installed
```bash
$ aws console help
NAME
console -
DESCRIPTION
Authenticate to AWS console
See 'aws help' for descriptions of global parameters.
SYNOPSIS
aws console [--profile=Name] [--timeout=Timeout] [--output-only=true|false]
OPTIONS
--timeout (string) Console session timeout in seconds, only for IAM
user credentials
--output-only (boolean) Print the console url instead of opening it in
the browser
See 'aws help' for descriptions of global parameters.
```
Usage Example
```bash
aws console --profile dev
```