docs-archive/apache-airflow/2.0.0/apache-airflow/stable/_sources/_api/airflow/secrets/index.rst.txt

:mod:`airflow.secrets`
======================

.. py:module:: airflow.secrets

.. autoapi-nested-parse::

   Secrets framework provides means of getting connection objects from various sources, e.g. the following:

   * Environment variables
   * Metastore database
   * AWS SSM Parameter store



Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   base_secrets/index.rst
   environment_variables/index.rst
   local_filesystem/index.rst
   metastore/index.rst


Package Contents
----------------

.. py:class:: BaseSecretsBackend(**kwargs)

   Bases: :class:`abc.ABC`

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

   
   .. staticmethod:: build_path(path_prefix: str, secret_id: str, sep: str = '/')

      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: str)

      Get conn_uri from Secrets Backend

      :param conn_id: connection id
      :type conn_id: str



   
   .. method:: get_connection(self, conn_id: str)

      Return connection object with a given ``conn_id``.

      :param conn_id: connection id
      :type conn_id: str



   
   .. method:: get_connections(self, conn_id: str)

      Return connection object with a given ``conn_id``.

      :param conn_id: connection id
      :type conn_id: str



   
   .. method:: get_variable(self, key: str)

      Return value for Airflow Variable

      :param key: Variable Key
      :type key: str
      :return: Variable Value



   
   .. method:: get_config(self, key: str)

      Return value for Airflow Config Key

      :param key: Config Key
      :return: Config Value




.. data:: DEFAULT_SECRETS_SEARCH_PATH
   :annotation: = ['airflow.secrets.environment_variables.EnvironmentVariablesBackend', 'airflow.secrets.metastore.MetastoreBackend']