Skip to content

Instantly share code, notes, and snippets.

@avoidik
Forked from nqbao/ssm_parameter_store.py
Created September 12, 2018 18:59
Show Gist options
  • Save avoidik/42c2829d20ec00e0a03f2ee8c84e994b to your computer and use it in GitHub Desktop.
Save avoidik/42c2829d20ec00e0a03f2ee8c84e994b to your computer and use it in GitHub Desktop.

Revisions

  1. @nqbao nqbao revised this gist Aug 24, 2018. 1 changed file with 26 additions and 14 deletions.
    40 changes: 26 additions & 14 deletions ssm_parameter_store.py
    Original file line number Diff line number Diff line change
    @@ -23,17 +23,18 @@
    from botocore.exceptions import ClientError
    import datetime


    class SSMParameterStore(object):
    """
    Provide a dictionary-like interface to access AWS SSM Parameter Store
    """
    def __init__(self, prefix=None, ssm_client=None, ttl=None):
    self._prefix = (prefix or "").rstrip("/") + "/"
    self._prefix = (prefix or '').rstrip('/') + '/'
    self._client = ssm_client or boto3.client('ssm')
    self._keys = None
    self._substores = {}
    self._ttl = ttl

    def get(self, name, **kwargs):
    assert name, 'Name can not be empty'
    if self._keys is None:
    @@ -48,6 +49,7 @@ def get(self, name, **kwargs):
    elif self._keys[name]['type'] == 'prefix':
    if abs_key not in self._substores:
    store = self.__class__(prefix=abs_key, ssm_client=self._client, ttl=self._ttl)
    store._keys = self._keys[name]['children']
    self._substores[abs_key] = store

    return self._substores[abs_key]
    @@ -57,21 +59,31 @@ def get(self, name, **kwargs):
    def refresh(self):
    self._keys = {}
    self._substores = {}
    responses = self._client.describe_parameters(

    paginator = self._client.get_paginator('describe_parameters')
    pager = paginator.paginate(
    ParameterFilters=[
    dict(Key="Path", Option="Recursive", Values=[self._prefix])
    ]
    )

    for page in pager:
    for p in page['Parameters']:
    paths = p['Name'][len(self._prefix):].split('/')
    self._update_keys(self._keys, paths)

    @classmethod
    def _update_keys(cls, keys, paths):
    name = paths[0]

    for p in responses[u'Parameters']:
    paths = p['Name'][len(self._prefix):].split('/')
    name = paths[0]

    # this is a prefix
    if len(paths) > 1:
    self._keys[name] = {'type': 'prefix'}
    else:
    self._keys[name] = {'type': 'parameter', 'expire': None}
    # this is a prefix
    if len(paths) > 1:
    if name not in keys:
    keys[name] = {'type': 'prefix', 'children': {}}

    cls._update_keys(keys[name]['children'], paths[1:])
    else:
    keys[name] = {'type': 'parameter', 'expire': None}

    def keys(self):
    if self._keys is None:
    @@ -90,7 +102,7 @@ def _get_value(self, name, abs_key):
    parameter = self._client.get_parameter(Name=abs_key, WithDecryption=True)['Parameter']
    value = parameter['Value']
    if parameter['Type'] == 'StringList':
    value = value.split(",")
    value = value.split(',')

    entry['value'] = value

    @@ -118,4 +130,4 @@ def __delitem__(self, name):
    raise NotImplementedError()

    def __repr__(self):
    return 'ParameterStore[%s]' % self._prefix
    return 'ParameterStore[%s]' % self._prefix
  2. @nqbao nqbao revised this gist Aug 24, 2018. 1 changed file with 21 additions and 0 deletions.
    21 changes: 21 additions & 0 deletions ssm_parameter_store.py
    Original file line number Diff line number Diff line change
    @@ -1,3 +1,24 @@
    # Copyright (c) 2018 Bao Nguyen <[email protected]>
    #
    # Permission is hereby granted, free of charge, to any person obtaining a copy
    # of this software and associated documentation files (the "Software"), to deal
    # in the Software without restriction, including without limitation the rights
    # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    # copies of the Software, and to permit persons to whom the Software is
    # furnished to do so, subject to the following conditions:
    #
    # The above copyright notice and this permission notice shall be included in all
    # copies or substantial portions of the Software.
    #
    # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    # SOFTWARE.
    # ==============================================================================

    import boto3
    from botocore.exceptions import ClientError
    import datetime
  3. @nqbao nqbao created this gist Apr 6, 2018.
    100 changes: 100 additions & 0 deletions ssm_parameter_store.py
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,100 @@
    import boto3
    from botocore.exceptions import ClientError
    import datetime

    class SSMParameterStore(object):
    """
    Provide a dictionary-like interface to access AWS SSM Parameter Store
    """
    def __init__(self, prefix=None, ssm_client=None, ttl=None):
    self._prefix = (prefix or "").rstrip("/") + "/"
    self._client = ssm_client or boto3.client('ssm')
    self._keys = None
    self._substores = {}
    self._ttl = ttl

    def get(self, name, **kwargs):
    assert name, 'Name can not be empty'
    if self._keys is None:
    self.refresh()

    abs_key = "%s%s" % (self._prefix, name)
    if name not in self._keys:
    if 'default' in kwargs:
    return kwargs['default']

    raise KeyError(name)
    elif self._keys[name]['type'] == 'prefix':
    if abs_key not in self._substores:
    store = self.__class__(prefix=abs_key, ssm_client=self._client, ttl=self._ttl)
    self._substores[abs_key] = store

    return self._substores[abs_key]
    else:
    return self._get_value(name, abs_key)

    def refresh(self):
    self._keys = {}
    self._substores = {}
    responses = self._client.describe_parameters(
    ParameterFilters=[
    dict(Key="Path", Option="Recursive", Values=[self._prefix])
    ]
    )

    for p in responses[u'Parameters']:
    paths = p['Name'][len(self._prefix):].split('/')
    name = paths[0]

    # this is a prefix
    if len(paths) > 1:
    self._keys[name] = {'type': 'prefix'}
    else:
    self._keys[name] = {'type': 'parameter', 'expire': None}

    def keys(self):
    if self._keys is None:
    self.refresh()

    return self._keys.keys()

    def _get_value(self, name, abs_key):
    entry = self._keys[name]

    # simple ttl
    if self._ttl == False or (entry['expire'] and entry['expire'] <= datetime.datetime.now()):
    entry.pop('value', None)

    if 'value' not in entry:
    parameter = self._client.get_parameter(Name=abs_key, WithDecryption=True)['Parameter']
    value = parameter['Value']
    if parameter['Type'] == 'StringList':
    value = value.split(",")

    entry['value'] = value

    if self._ttl:
    entry['expire'] = datetime.datetime.now() + datetime.timedelta(seconds=self._ttl)
    else:
    entry['expire'] = None

    return entry['value']

    def __contains__(self, name):
    try:
    self.get(name)
    return True
    except:
    return False

    def __getitem__(self, name):
    return self.get(name)

    def __setitem__(self, key, value):
    raise NotImplementedError()

    def __delitem__(self, name):
    raise NotImplementedError()

    def __repr__(self):
    return 'ParameterStore[%s]' % self._prefix