compwright/aws-env

Load environment variables securely from AWS SSM

Maintainers

Details

github.com/compwright/aws-env

Source

Issues

Installs: 3 792

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

v2.0.0 2024-01-06 15:59 UTC

Requires

Requires (Dev)

MIT 0458194c8d038c4a3cdf2918421e536da134cadb

  • Jonathon Hill <jonathon.woop@compwright.com>

This package is auto-updated.

Last update: 2024-11-06 17:44:01 UTC

README

Command-line script to obtain service configuration environment and secrets securely from AWS SSM.

Configuration

Configuration can be provided via command line options or environment variables:

This script can find AWS credentials in the usual ways, including:

  1. If running on EC2, by assuming an IAM role (recommended)
  2. By reading the ~/.aws/config and ~/.aws/credentials files, with the optional AWS_PROFILE environment variable
  3. Explicitly with the AWS_REGION, AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables

Usage

Usage:
  aws-env [options]

Options:
  -p, --path=PATH       Parameter key path [default: "/"]
  -f, --format=FORMAT   Output format: dotenv, env, export [default: "env"]
  -h, --help            Display help for the given command. When no command is given display help for the bin/aws-env command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

For example, to start a shell with a new environment consisting only of the items pulled from AWS SSM + $PATH:

env -i -S"$(bin/aws-env -p /my_app/development) PATH=$PATH" && /bin/bash

License

MIT License