airflow.providers.amazon.aws.secrets.systems_manager

與從 AWS SSM Parameter Store 獲取連線相關的物件。

SystemsManagerParameterStoreBackend

從 AWS SSM Parameter Store 檢索連線或變數。

模組內容

class airflow.providers.amazon.aws.secrets.systems_manager.SystemsManagerParameterStoreBackend(connections_prefix='/airflow/connections', connections_lookup_pattern=None, variables_prefix='/airflow/variables', variables_lookup_pattern=None, config_prefix='/airflow/config', config_lookup_pattern=None, **kwargs)[source]

基類:airflow.secrets.BaseSecretsBackend, airflow.utils.log.logging_mixin.LoggingMixin

從 AWS SSM Parameter Store 檢索連線或變數。

可透過 airflow.cfg 如下配置

[secrets]
backend = airflow.providers.amazon.aws.secrets.systems_manager.SystemsManagerParameterStoreBackend
backend_kwargs = {"connections_prefix": "/airflow/connections", "profile_name": null}

例如,如果 ssm 路徑是 /airflow/connections/smtp_default,則如果你提供了 {"connections_prefix": "/airflow/connections"} 並請求 conn_id smtp_default,則可以訪問。如果 ssm 路徑是 /airflow/variables/hello,則如果你提供了 {"variables_prefix": "/airflow/variables"} 和變數鍵 hello,則可以訪問。

引數
  • connections_prefix (str) – 指定用於讀取連線 Secret 的字首。如果設定為 None (null),則不會向 AWS SSM Parameter Store 傳送連線請求。

  • connections_lookup_pattern (str | None) – 指定連線 ID 需要匹配的模式,以便在 AWS Parameter Store 中查詢。僅在 connections_prefix 不是 None 時適用。如果設定為 None(配置中的空值),所有連線將首先在 AWS Parameter Store 中查詢。

  • variables_prefix (str) – 指定用於讀取變數 Secret 的字首。如果設定為 None (null),則不會向 AWS SSM Parameter Store 傳送變數請求。

  • variables_lookup_pattern (str | None) – 指定變數鍵需要匹配的模式,以便在 AWS Parameter Store 中查詢。僅在 variables_prefix 不是 None 時適用。如果設定為 None(配置中的空值),所有變數將首先在 AWS Parameter Store 中查詢。

  • config_prefix (str) – 指定用於讀取配置 Secret 的字首。如果設定為 None (null),則不會向 AWS SSM Parameter Store 傳送配置請求。

  • config_lookup_pattern (str | None) – 指定配置鍵需要匹配的模式,以便在 AWS Parameter Store 中查詢。僅在 config_prefix 不是 None 時適用。如果設定為 None(配置中的空值),所有配置鍵將首先在 AWS Parameter Store 中查詢。

你也可以向此類傳遞 AWS Connection Extra 配置中列出的額外關鍵字引數,它們將用於建立連線並傳遞給 Boto3 客戶端。

[secrets]
backend = airflow.providers.amazon.aws.secrets.systems_manager.SystemsManagerParameterStoreBackend
backend_kwargs = {"connections_prefix": "airflow/connections", "region_name": "eu-west-1"}

另請參閱

配置連線

connections_lookup_pattern = None[source]
variables_lookup_pattern = None[source]
config_lookup_pattern = None[source]
profile_name[source]
api_version[source]
use_ssl[source]
kwargs[source]
property client[source]

建立 SSM 客戶端。

get_conn_value(conn_id)[source]

獲取引數值。

引數

conn_id (str) – 連線 ID

get_variable(key)[source]

獲取 Airflow 變數。

引數

key (str) – 變數鍵

返回

變數值

返回型別

str | None

get_config(key)[source]

獲取 Airflow 配置。

引數

key (str) – 配置選項鍵

返回

配置選項值

返回型別

str | None

此條目有幫助嗎?