runway.cfngin.lookups.handlers.ssmstore module

AWS SSM Parameter Store lookup.

class runway.cfngin.lookups.handlers.ssmstore.SsmstoreLookup[source]

Bases: runway.lookups.handlers.base.LookupHandler

AWS SSM Parameter Store lookup.

DEPRECATION_MSG = 'ssmstore lookup has been deprecated; use the ssm lookup instead'
classmethod handle(value, context=None, provider=None, **kwargs)[source]

Retrieve (and decrypt) a parameter from AWS SSM Parameter Store.

Parameters
Returns

Looked up value.

Return type

str

value should be in the following format:

[<region>@]ssmkey

Note

The region is optional, and defaults to us-east-1 if not given.

Example

# In CFNgin we would reference the encrypted value like:
conf_key: ${ssmstore us-east-1@ssmkey}

You can optionally store the value in a file, ie:

ssmstore_value.txt
us-east-1@ssmkey

and reference it within CFNgin (NOTE: the path should be relative to the CFNgin config file):

conf_key: ${ssmstore file://ssmstore_value.txt}

# Both of the above would resolve to
conf_key: PASSWORD