airflow.secrets.base_secrets
¶
Module Contents¶
Classes¶
Abstract base class to retrieve Connection object given a conn_id or Variable given a key |
- class airflow.secrets.base_secrets.BaseSecretsBackend[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, secret_id, sep='/')[source]¶
Given conn_id, build path for Secrets Backend
- abstract get_conn_value(conn_id)[source]¶
Retrieve from Secrets Backend a string value representing the Connection object.
If the client your secrets backend uses already returns a python dict, you should override
get_connection
instead.- Parameters
conn_id (str) – connection id
- deserialize_connection(conn_id, value)[source]¶
Given a serialized representation of the airflow Connection, return an instance. Looks at first character to determine how to deserialize.
- Parameters
- Returns
the deserialized Connection
- Return type
- abstract get_conn_uri(conn_id)[source]¶
Get conn_uri from Secrets Backend
This method is deprecated and will be removed in a future release; implement
get_conn_value
instead.- Parameters
conn_id (str) – connection id
- get_connection(conn_id)[source]¶
Return connection object with a given
conn_id
.Tries
get_conn_value
first and if not implemented, triesget_conn_uri
- Parameters
conn_id (str) – connection id
- get_connections(conn_id)[source]¶
Return connection object with a given
conn_id
.- Parameters
conn_id (str) – connection id