airflow.secrets.base_secrets

Module Contents

Classes

BaseSecretsBackend

Abstract base class to retrieve Connection object given a conn_id or Variable given a key
class airflow.secrets.base_secrets.BaseSecretsBackend(**kwargs)[source]

Bases: abc.ABC

Abstract base class to retrieve Connection object given a conn_id or Variable given a key

static build_path(path_prefix: str, secret_id: str, sep: str = '/') → str[source]

Given conn_id, build path for Secrets Backend

Parameters

  • path_prefix (str) – Prefix of the path to get secret

  • secret_id (str) – Secret id

  • sep (str) – separator used to concatenate connections_prefix and conn_id. Default: “/”

abstract get_conn_uri(self, conn_id: str) → Optional[str][source]

Get conn_uri from Secrets Backend

Parameters

conn_id (str) – connection id

get_connection(self, conn_id: str) → Optional[airflow.models.connection.Connection][source]

Return connection object with a given conn_id.

Parameters

conn_id (str) – connection id

get_connections(self, conn_id: str) → List[airflow.models.connection.Connection][source]

Return connection object with a given conn_id.

Parameters

conn_id (str) – connection id

abstract get_variable(self, key: str) → Optional[str][source]

Return value for Airflow Variable

Parameters

key (str) – Variable Key

Returns

Variable Value

get_config(self, key: str) → Optional[str][source]

Return value for Airflow Config Key

Parameters

key – Config Key

Returns

Config Value

Was this entry helpful?