FromParameterStore class

class cfp.sources.FromParameterStore(name: str, region: Optional[str] = None, session: Optional[boto3.session.Session] = None)

Describes how to look-up a value in Amazon Web Services Systems Manager Parameter Store.

For example:

from cfp import StackParameters
from cfp.sources import FromParameterStore

sp = StackParameters()
sp.add("InstanceType", FromParameterStore("/instance-type"))

name: str

Name of the parameter in Parameter Store.

region: Optional[str] = None

Amazon Web Services region in which the parameter resides.

Not required if session is configured for the correct region, or if session is omitted but the default session region is correct.

session: Optional[boto3.session.Session] = None

boto3 session to use to retrieve the value from Parameter Store.

A new session will be created if omitted. If region is set then the new session will be configured for that region, otherwise the default session region will be used.

You must specify a session if you want to read Parameter Store values in another account.