ssm-to-json

It is a configuration management tool. With the help of AWS SSM call get-path-by-paramter, the tool retrieves all nested keys underneath the provided path. This tool then transforms the path into json object for configuration, which is stored in a json file with provided name.

Installation

To install globally

$ npm i -g @returnlogic/ssm-to-json

Options

• --path <value> (string)
  Required
  The value provided is the hierarchy for the parameter. Hierarchies start and end with a forward slash. A parameter name hierarchy can have a maximum of 15 levels.
  For example: /rl/production/

• --output-path <value> (string)
  Required
  The value provided is the name of the file where created json object is printed and stored. This file will be created in the directory where this command is ran.
  For example: test.json

• [--recursive | --no-recursive] (boolean)
  Default: recursive
  It retrieves all parameters within a hierarchy.

• [--with-decryption | --no-with-decryption] (boolean)
  Default: with-decryption
  It retrieves all parameters in a hierarchy with their value decrypted.

• --max-results <value> (integer)
  The value provided is the total number of items returned. The number of items returned can be between zero and the provided value.

• --access-key <value> (string)
  Default: the access key saved in the user's system
  The access key provided is used to configure aws sdk which allows you to make AWS service call. Both access key and secret key needs to match up.

• --secret-key <value> (string)
  Default: the secret key saved in the user's system
  The secret key provided is used to configure aws sdk which allows you to make AWS service call. Both access key and secret key needs to match up.

• --region <value> (string)
  Default: us-east-1
  The region provided is used to configure aws sdk which allows you to make AWS service call in the provided region.