airflow.contrib.secrets.aws_systems_manager

Objects relating to sourcing connections from AWS SSM Parameter Store

Module Contents

class airflow.contrib.secrets.aws_systems_manager.SystemsManagerParameterStoreBackend(connections_prefix='/airflow/connections', variables_prefix='/airflow/variables', 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.contrib.secrets.aws_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.

  • variables_prefix (str) – Specifies the prefix of the secret to read to get Variables.

  • profile_name (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_uri(self, conn_id)[source]

Get param value

Parameters

conn_id (str) – connection id

Return type

str

get_variable(self, key)[source]

Get Airflow Variable from Environment Variable

Parameters

key – Variable Key

Returns

Variable Value

_get_secret(self, path_prefix, secret_id)[source]

Get secret value from Parameter Store.

Parameters

  • path_prefix (str) – Prefix for the Path to get Secret

  • secret_id (str) – Secret Key

Was this entry helpful?