airflow.providers.amazon.aws.secrets.systems_manager

Objects relating to sourcing connections from AWS SSM Parameter Store

Module Contents

Classes

SystemsManagerParameterStoreBackend

Retrieves Connection or Variables from AWS SSM Parameter Store
class airflow.providers.amazon.aws.secrets.systems_manager.SystemsManagerParameterStoreBackend(connections_prefix='/airflow/connections', variables_prefix='/airflow/variables', config_prefix='/airflow/config', profile_name=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_id smtp_default. And if ssm path is /airflow/variables/hello, this would be accessible if you provide {"variables_prefix": "/airflow/variables"} and request conn_id hello.

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 (Optional[str]) -- The name of a profile to use. If not given, then the default profile is used.

client(self)[source]

Create a SSM client

get_conn_value(self, conn_id)[source]

Get param value

Parameters

conn_id (str) -- connection id

get_conn_uri(self, conn_id)[source]

Return URI representation of Connection conn_id.

As of Airflow version 2.3.0 this method is deprecated.

Parameters

conn_id (str) -- the connection id

Returns

deserialized Connection

Return type

Optional[str]

get_variable(self, key)[source]

Get Airflow Variable from Environment Variable

Parameters

key (str) -- Variable Key

Returns

Variable Value

Return type

Optional[str]

get_config(self, key)[source]

Get Airflow Configuration

Parameters

key (str) -- Configuration Option Key

Returns

Configuration Option Value

Return type

Optional[str]

Was this entry helpful?