Giter VIP home page Giter VIP logo

ssm-sync's Introduction

CLI and node tool for synchronously loading AWS Parameter store values

Getting started - Typescript / Javascript

Add ssm-sync to your project

$ npm install ssm-sync
#or
$ yarn add ssm-sync

Getting started

Globally install ssm-sync

$ npm install ssm-sync -g
#or
$ yarn global add ssm-sync

Load Parameter store values at path=PARAMETER_PATH

$ ssm-sync --path "/<PARAMETER_PATH>"

Load Parameter store values at path in javascript

import {getParameters} from "ssm-sync";
let ssmParams = getParameters({
    path: "/dev"
    key?: <AWS_ACCESS_KEY_ID>,
    secret?:  <AWS_SECRET_ACCESS_KEY>,
    region?:  <AWS_DEFAULT_REGION>
})

Load Parameter Store values at path with env vars and autoload into process.env

SSM_PATH='/path/to/ssm/params'
#or
SSM_PATHS='/path/to/ssm/params,/path/to/other/params,...'

Note the parameters will be loaded in order, so each path in SSM_PATHS will override previously loaded paths

CLI arguments

  • npx ssm-sync --help - Get possible arguments
  • npx ssm-sync --path "/dev" - get all parameters under the /dev path (path is required)
  • npx ssm-sync --path "/dev" --secret <AWS_SECRET_ACCESS_KEY> --key <AWS_ACCESS_KEY_ID> --region <AWS_DEFAULT_REGION> - use custom aws credentials, otherwise, the tool will use whatever is configured in your env (profiles, env variables, etc.)

ssm-sync's People

Contributors

webkoils avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.