Metadata-Version: 2.1
Name: aws-ssm-commander
Version: 0.0.2
Summary: A utility for dealing with AWS SSM Parameter Store
Home-page: https://github.com/djcrabhat/aws-ssm-commander
License: UNKNOWN
Description: # aws-ssm-commander
        
        [![Build Status](https://travis-ci.org/djcrabhat/aws-ssm-commander.svg?branch=master)](https://travis-ci.org/djcrabhat/aws-ssm-commander)
        
        Inspired by [aws-ssm-tree](https://github.com/brunorubin/aws-ssm-tree)
        
        ## Install
        ```
        pip install aws-ssm-commander
        ```
        
        ## Usage
        ```
        Options:
          --debug
          --help   Show this message and exit.
        
        Commands:
          dump   Dump the values in ssm to a param file, for backup or inspection.
          tree   Print out a tree of your SSM parameters
          write  take a yaml file, put it in to SSM
        ```
        
        ### dump
        Dumps the params on a path to a json or yaml output
        ```
        ~> aws-ssm-commander dump /abc/123
        section_a:
          username: abc123
        section_b:
          password: blah
          username: foobar
        ```
            
        ### tree
        See a visual representation of params on a path.  Useful for making sure your params out in SSM are structured as 
        expected
        ```
        ~> aws-ssm-commander tree /abc/123/
        abc
        â””â”€â”€ 123
            â”œâ”€â”€ section_a
            â”‚   â””â”€â”€ username
            â”œâ”€â”€ section_b
            â”‚   â”œâ”€â”€ password
            â”‚   â””â”€â”€ username
        ```
        
        ### write
        Takes a yaml input file and a path prefix, and writes params to SSM.
        
        ```
        ~> aws-ssm-commander write /abc/123/ my_file.yml
        ```
        
        ##### Saving secrets
        So it's great that you can now store a bunch of KMS params in a config file, that you probably wanna keep in git somewhere.
        But a lot of the stuff you want to put in Param Store are secrets, and you don't store plaintext secrets in git!  Now 
        you could encrypt and decrypt these files on your own, but aws-ssm-commander supports putting a KMS blob in a config file.
        
        You can put a KMS secret in your config files by prefixing a value with a `!kms` tag
        
        To get a kms blob, 
        ```bash
        
        KEY_ID=1234abcd-12ab-34cd-56ef-1234567890ab
        aws kms encrypt --key-id $KEY_ID --plaintext "MY_SECRET" --output text --query CiphertextBlob 
        ```
        
        take that output, then drop it in a value in a yaml file like so:
        
        ```yaml
        my_thing:
          username: foobar
          password: !kms WW05aWJHRjNZbXh2WWc9PQ==
        ```
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
