Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cytopia/aws-export-profile

Export AWS profiles to your shell environment
https://github.com/cytopia/aws-export-profile

aws aws-boto3 aws-cli aws-profile boto boto-profile environment-variables environment-vars

Last synced: 22 days ago
JSON representation

Export AWS profiles to your shell environment

Host: GitHub
URL: https://github.com/cytopia/aws-export-profile
Owner: cytopia
License: mit
Created: 2018-02-19T19:35:52.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2019-07-02T03:44:53.000Z (over 5 years ago)
Last Synced: 2024-10-03T12:19:01.246Z (about 1 month ago)
Topics: aws, aws-boto3, aws-cli, aws-profile, boto, boto-profile, environment-variables, environment-vars
Language: Shell
Homepage:
Size: 23.4 KB
Stars: 46
Watchers: 4
Forks: 17
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

# aws-export-profile

`aws-export-profile` is a bash script that will output AWS export statements of your chosen aws boto profile. In case you have to manage multiple AWS accounts that rely on different boto profiles, you can *activate* a chosen profile by making it available in your shell environment.

This tool reads credentials from `~/.aws/credentials`. If you are looking for a way to export boto profiles via `aws sts assume-role` instead, have a lookt at **[aws-export-assume-profile](https://github.com/cytopia/aws-export-assume-profile)**.

[![Build Status](https://travis-ci.org/cytopia/aws-export-profile.svg?branch=master)](https://travis-ci.org/cytopia/aws-export-profile)
![Release](https://img.shields.io/github/release/cytopia/aws-export-profile.svg)

**Note:** Wrap the command in **`$(aws-export-profile)`** to actually export your boto environment variables.

## But why?

Most AWS related tools support boto profiles out of the box, such as the `aws-cli` (Example: `aws ec2 --profile $(aws-export-profile staging)

# Make AWS login available inside your Docker container
user> docker run --rm -it \
--env AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID \
--env AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY \
--env AWS_REGION=$AWS_REGION \
my-aws-docker
```

## Available exports

The following export variables are currently supported.

| Variable | Description |
|------------------------|-------------|
| `AWS_ACCESS_KEY` | Access key |
| `AWS_ACCESS_KEY_ID` | Alternative name for `AWS_ACCESS_KEY`|
| `AWS_SECRET_KEY` | Secret key |
| `AWS_SECRET_ACCESS_KEY`| Alternative name for `AWS_SECRET_KEY`|
| `AWS_SESSION_TOKEN` | Session token |
| `AWS_DELEGATION_TOKEN` | Alternative name for `AWS_SESSION_TOKEN` |
| `AWS_SECURITY_TOKEN` | Secret token |
| `AWS_REGION` | Region|

## Examples

This tool simply output the exports to stdout. In order to auto-source them, wrap the command in **`$(...)`**.

#### Boto profile `testing`

```bash
user> aws-export-profile testing

#### Boto profile `testing` with custom paths

```bash
user> aws-export-profile deploy /jenkins/aws/credentials /jenkins/aws/config

#### Boto profile `production` with more exports
```bash
user> aws-export-profile production

export AWS_ACCESS_KEY_ID="XXXXXXXXXXXXXXXXXXXX"
export AWS_ACCESS_KEY="XXXXXXXXXXXXXXXXXXXX"
export AWS_SECRET_ACCESS_KEY="A1Bc/XXXXXXXXXXXXXXXXXXXXXXXXXXX"
export AWS_SECRET_KEY="A1Bc/XXXXXXXXXXXXXXXXXXXXXXXXXXX"
export AWS_SESSION_TOKEN="XXXXXXXXXXXXXXXXx/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXX="
export AWS_DELEGATION_TOKEN="XXXXXXXXXXXXXXXXx/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXX="
export AWS_REGION="eu-central-1"
```

#### Export boto profile `production`
```bash
user> $(aws-export-profile production)

# Validate
user> env | grep AWS_

AWS_ACCESS_KEY_ID="XXXXXXXXXXXXXXXXXXXX"
AWS_ACCESS_KEY="XXXXXXXXXXXXXXXXXXXX"
AWS_SECRET_ACCESS_KEY="A1Bc/XXXXXXXXXXXXXXXXXXXXXXXXXXX"
AWS_SECRET_KEY="A1Bc/XXXXXXXXXXXXXXXXXXXXXXXXXXX"
AWS_SESSION_TOKEN="XXXXXXXXXXXXXXXXx/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXX="
AWS_DELEGATION_TOKEN="XXXXXXXXXXXXXXXXx/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXX="
AWS_REGION="eu-central-1"
```

#### Unset all AWS_ variables
```bash
user> $(aws-export-profile -u)
```

## Usage

```bash
Usage: aws-export-profile [profile] [credentials] [config]
aws-export-profile --unset, -u
aws-export-profile --help|-h
aws-export-profile --version|-v

This bash helper will output AWS export statements of your chosen aws boto profile.
Wrap this script in $(aws-export-profile) to export those environment variables.

Optional parameter:
[profile] Boto profile name to export. Default is 'default'
[credentials] Path to your aws credentials file.
Default is ~/.aws/credentials
[config] Path to your aws config file.
If no config file is found, AWS_REGION export will not be available.
Default is ~/.aws/config

Arguments:
--unset, -u Unset currently set AWS variables from env
--help, -h Show this help screen
--version, -v Show version

Available exports:
AWS_ACCESS_KEY_ID
AWS_ACCESS_KEY
AWS_SECRET_ACCESS_KEY
AWS_SECRET_KEY
AWS_SESSION_TOKEN
AWS_DELEGATION_TOKEN
AWS_SECURITY_TOKEN
AWS_REGION

Examples to show output:
aws-export-profile testing
aws-export-profile production /jenkins/aws/credentials /jenkins/aws/config

Examples to export:
$(aws-export-profile testing)
$(aws-export-profile production /jenkins/aws/credentials /jenkins/aws/config)

Examples to unset all AWS variables
\$(aws-export-profile -u)
```

## License

**[MIT License](LICENSE.md)**