blob: a402390f20bcf9530cad9813bf624e9095bf3e15 [file] [log] [blame]
:mod:`airflow.secrets.base_secrets`
===================================
.. py:module:: airflow.secrets.base_secrets
Module Contents
---------------
.. py:class:: BaseSecretsBackend(**kwargs)
Abstract base class to retrieve secrets given a conn_id and construct a Connection object
.. attribute:: __metaclass__
.. staticmethod:: build_path(path_prefix, secret_id, sep='/')
Given conn_id, build path for Secrets Backend
:param path_prefix: Prefix of the path to get secret
:type path_prefix: str
:param secret_id: Secret id
:type secret_id: str
:param sep: separator used to concatenate connections_prefix and conn_id. Default: "/"
:type sep: str
.. method:: get_conn_uri(self, conn_id)
Get conn_uri from Secrets Backend
:param conn_id: connection id
:type conn_id: str
.. method:: get_connections(self, conn_id)
Get connections with a specific ID
:param conn_id: connection id
:type conn_id: str
.. method:: get_variable(self, key)
Return value for Airflow Connection
:param key: Variable Key
:return: Variable Value
.. method:: get_config(self, key)
Return value for Airflow Config Key
:param key: Config Key
:return: Config Value