`airflow.providers.amazon.aws.secrets.systems_manager`¶

从 AWS SSM 参数存储获取连接的对象。

模块内容¶

类¶

SystemsManagerParameterStoreBackend

从 AWS SSM 参数存储检索连接或变量。

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)[源代码]¶

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

从 AWS SSM 参数存储检索连接或变量。

可通过 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) – 指定要读取以获取连接的密钥的前缀。如果设置为 None（空值），则不会将连接请求发送到 AWS SSM 参数存储。
connections_lookup_pattern (str | None) – 指定连接 ID 需要匹配的模式才能在 AWS 参数存储中查找。仅当 connections_prefix 不为 None 时应用。如果设置为 None（配置中的空值），则首先在 AWS 参数存储中查找所有连接。
variables_prefix (str) – 指定要读取以获取变量的密钥的前缀。如果设置为 None（空值），则不会将变量请求发送到 AWS SSM 参数存储。
variables_lookup_pattern (str | None) – 指定变量键需要匹配的模式才能在 AWS 参数存储中查找。仅当 variables_prefix 不为 None 时应用。如果设置为 None（配置中的空值），则首先在 AWS 参数存储中查找所有变量。
config_prefix (str) – 指定要读取以获取变量的密钥的前缀。如果设置为 None（空值），则不会将配置请求发送到 AWS SSM 参数存储。
config_lookup_pattern (str | None) – 指定配置键需要匹配的模式才能在 AWS 参数存储中查找。仅当 config_prefix 不为 None 时应用。如果设置为 None（配置中的空值），则首先在 AWS 参数存储中查找所有配置键。

您还可以将 AWS 连接额外配置中列出的其他关键字参数传递给此类，它们将用于建立连接并传递给 Boto3 客户端。

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

另请参阅

配置连接

client()[源代码]¶: 创建 SSM 客户端。

get_conn_value(conn_id)[源代码]¶

获取参数值。

参数: conn_id (str) – 连接 ID

get_variable(key)[源代码]¶

获取 Airflow 变量。

参数: key (str) – 变量键
返回: 变量值
返回类型: str | None

get_config(key)[源代码]¶

获取 Airflow 配置。

参数: key (str) – 配置选项键
返回: 配置选项值
返回类型: str | None

airflow.providers.amazon.aws.secrets.systems_manager¶

模块内容¶

类¶

`airflow.providers.amazon.aws.secrets.systems_manager`¶