Parse AWS Systems Manager parameters to environment variables.
This action is designed to read AWS SSM parameters and exports them as environmental variables.
Script can parse string value parameters as well as parameters with stringified JSON values. For simple JSON objects
a shortcut parameter simple_json can be used to convert all key-values from JSON into environmental variables.
Action expects 3 secrets to be set in GitHub's repository:
AWS_REGION- AWS Region (e.g.us-east1)AWS_ACCESS_KEY_ID- AWS Access Key for user with an SSM access policy (e.g. AmazonSSMReadOnlyAccess)AWS_SECRET_ACCESS_KEY- User's AWS Access Key
| Parameter name | Type | Required | Default Value | Description |
|---|---|---|---|---|
ssm_parameter_list |
string | true | AWS Systems Manager parameter name (path) or comma separated list of paths | |
prefix |
string | false | AWS_SSM_ | Custom environmental variables prefix |
simple_json |
boolean | true | false | Parse parameter values as one-level JSON object and convert keys to environmental variables (see example below). |
jq_params |
string | true | Custom space-separated jq filters (see example below). |
Parse simple string value stored in AWS SSM my_parameter_name parameter:
name: Parse SSM parameter
on:
push
jobs:
aws-ssm-to-env:
runs-on: ubuntu-latest
steps:
- name: aws-ssm-to-env
uses: bomb-on/aws-ssm-to-env@master
env:
AWS_REGION: ${{ secrets.AWS_REGION }}
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
with:
ssm_parameter_list: 'my_parameter_name'Example above will set environmental variable AWS_SSM_MY_PARAMETER_NAME with value from the AWS SSM parameter itself.
Use comma separated list of strings to fetch multiple parameter values at once:
name: Parse SSM parameter
on:
push
jobs:
aws-ssm-to-env:
runs-on: ubuntu-latest
steps:
- name: aws-ssm-to-env
uses: bomb-on/aws-ssm-to-env@master
env:
AWS_REGION: ${{ secrets.AWS_REGION }}
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
with:
ssm_parameter_list: |
my_first_parameter,
my_second_parameterExample above will set environmental variable AWS_SSM_MY_FIRST_PARAMETER and AWS_SSM_MY_SECOND_PARAMETER with corresponding values from AWS SSM.
Parse simple string value stored in AWS SSM my_parameter_name parameter and export environmental variable with a
custom prefix:
name: Parse SSM parameter
on:
push
jobs:
aws-ssm-to-env:
runs-on: ubuntu-latest
steps:
- name: aws-ssm-to-env
uses: bomb-on/aws-ssm-to-env@master
env:
AWS_REGION: ${{ secrets.AWS_REGION }}
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
with:
ssm_parameter_list: 'my_parameter_name'
prefix: FOO_Example above will set environmental variable FOO_MY_PARAMETER_NAME with value from the AWS SSM parameter itself.
Parse simple one-level JSON object and create environmental variables from all keys:
name: Parse JSON SSM parameter
on:
push
jobs:
aws-ssm-to-env:
runs-on: ubuntu-latest
steps:
- name: aws-ssm-to-env
uses: bomb-on/aws-ssm-to-env@master
env:
AWS_REGION: ${{ secrets.AWS_REGION }}
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
with:
ssm_parameter_list: 'my_json_parameter'
simple_json: trueIf my_json_parameter in the example above is a JSON string like
{"foo": "bar", "baz": 1}environmental variables will be set as:
AWS_SSM_FOO=bar
AWS_SSM_BAZ=1Pass a custom, space-separated filter(s) to jq and parse desired parts of JSON object:
name: Parse JSON SSM parameter
on:
push
jobs:
aws-ssm-to-env:
runs-on: ubuntu-latest
steps:
- name: aws-ssm-to-env
uses: bomb-on/aws-ssm-to-env@master
env:
AWS_REGION: ${{ secrets.AWS_REGION }}
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
with:
ssm_parameter_list: 'my_json_parameter'
jq_filter: '.db[]|select(.default).host .db[]|select(.default).port'
prefix: DB_If my_json_parameter in the example above was a JSON string like
{"db": [{"host": "my.db.host.com", "port": 1337, "default": true}, {"host": "other.host", "port": 42}]}environmental variables will be set as:
DB_HOST=my.db.host.com
DB_PORT=1337-
Use official Docker container once it becomes available (aws/aws-cli#3291, aws/aws-cli#4685) - Write tests (https://github.com/kward/shunit2)