airflow.providers.amazon.aws.secrets.systems_manager
¶
Objects relating to sourcing connections from AWS SSM Parameter Store
Module Contents¶
-
class
airflow.providers.amazon.aws.secrets.systems_manager.
SystemsManagerParameterStoreBackend
(connections_prefix: str = '/airflow/connections', variables_prefix: str = '/airflow/variables', config_prefix: str = '/airflow/config', profile_name: Optional[str] = None, **kwargs)[source]¶ Bases:
airflow.secrets.BaseSecretsBackend
,airflow.utils.log.logging_mixin.LoggingMixin
Retrieves Connection or Variables from AWS SSM Parameter Store
Configurable via
airflow.cfg
like so:[secrets] backend = airflow.providers.amazon.aws.secrets.systems_manager.SystemsManagerParameterStoreBackend backend_kwargs = {"connections_prefix": "/airflow/connections", "profile_name": null}
For example, if ssm path is
/airflow/connections/smtp_default
, this would be accessible if you provide{"connections_prefix": "/airflow/connections"}
and request conn_idsmtp_default
. And if ssm path is/airflow/variables/hello
, this would be accessible if you provide{"variables_prefix": "/airflow/variables"}
and request conn_idhello
.- Parameters
connections_prefix (str) -- Specifies the prefix of the secret to read to get Connections. If set to None (null), requests for connections will not be sent to AWS SSM Parameter Store.
variables_prefix (str) -- Specifies the prefix of the secret to read to get Variables. If set to None (null), requests for variables will not be sent to AWS SSM Parameter Store.
config_prefix (str) -- Specifies the prefix of the secret to read to get Variables. If set to None (null), requests for configurations will not be sent to AWS SSM Parameter Store.
profile_name (str) -- The name of a profile to use. If not given, then the default profile is used.
-
get_variable
(self, key: str)[source]¶ Get Airflow Variable from Environment Variable
- Parameters
key -- Variable Key
- Returns
Variable Value