community.aws.waf_info 模块 – 检索 WAF ACL、规则、条件和过滤器的信息

注意

此模块是 community.aws 集合 (版本 9.0.0) 的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定： community.aws.waf_info。

community.aws 1.0.0 中的新增功能

概要

  • 检索 WAF ACL、规则、条件和过滤器的信息。

  • 在 5.0.0 版本之前，此模块名为 community.aws.aws_waf_info。用法没有改变。

别名：aws_waf_info

要求

在执行此模块的主机上需要满足以下要求。

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

参数

参数

注释

access_key

别名：aws_access_key_id, aws_access_key, ec2_access_key

字符串

AWS 访问密钥 ID。

有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

还可以使用 AWS_ACCESS_KEY_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量，优先级依次降低。

aws_access_key 和 profile 选项是互斥的。

为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。

ec2_access_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。

对 EC2_ACCESS_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。

aws_ca_bundle

路径

用于验证 SSL 证书的 CA 捆绑包的位置。

也可以使用 AWS_CA_BUNDLE 环境变量。

aws_config

字典

用于修改 botocore 配置的字典。

可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。

debug_botocore_endpoint_logs

布尔值

使用 botocore.endpoint 记录器来解析任务期间进行的唯一（而不是总数）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调来输出 playbook 期间制作的总列表。

也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ←（默认）

  • true

endpoint_url

别名：ec2_url, aws_endpoint_url, s3_url

字符串

连接到而不是默认 AWS 端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。

也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次降低。

ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中删除。

对 EC2_URL 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。

name

字符串

Web 应用程序防火墙的名称。

profile

别名：aws_profile

字符串

用于身份验证的命名 AWS 配置文件。

有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。

也可以使用 AWS_PROFILE 环境变量。

profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。

region（区域）

别名: aws_region, ec2_region

字符串

要使用的 AWS 区域。

对于诸如 IAM、Route53 和 CloudFront 等全局服务，region（区域）将被忽略。

也可以使用 AWS_REGION 或 EC2_REGION 环境变量。

有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。

ec2_region 别名已弃用，将在 2024-12-01 之后的版本中删除

对 EC2_REGION 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。

secret_key（密钥）

别名: aws_secret_access_key, aws_secret_key, ec2_secret_key

字符串

AWS secret access key（AWS 私有访问密钥）。

有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

也可以按优先级降序使用 AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY 环境变量。

secret_key（密钥）和 profile（配置文件）选项是互斥的。

为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。

ec2_secret_key 别名已弃用，将在 2024-12-01 之后的版本中删除。

对 EC2_SECRET_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。

session_token（会话令牌）

别名: aws_session_token, security_token, aws_security_token, access_token

字符串

用于临时凭证的 AWS STS 会话令牌。

有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

也可以按优先级降序使用 AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN 环境变量。

security_token（安全令牌）和 profile（配置文件）选项是互斥的。

别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数名称在 6.0.0 版本中从 security_token 重命名为 session_token。

security_token（安全令牌）、aws_security_token 和 access_token 别名已弃用，将在 2024-12-01 之后的版本中删除。

对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。

validate_certs（验证证书）

布尔值

设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。

强烈建议不要设置 validate_certs=false，作为替代方法，请考虑设置 aws_ca_bundle。

选项

  • false

  • true ← (默认)

waf_regional（WAF 区域性）

布尔值

是否使用 waf-regional 模块。

选项

  • false ←（默认）

  • true

注释

注意

  • 注意：对于模块，环境变量和配置文件是从 Ansible “主机”上下文而不是“控制器”上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible “控制器”上下文而不是“主机”上下文读取的。

  • Ansible 使用的 AWS SDK (boto3) 也可能从其在 Ansible “主机”上下文（通常为 ~/.aws/credentials）中的配置文件中读取凭据和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

- name: obtain all WAF information
  community.aws.waf_info:

- name: obtain all information for a single WAF
  community.aws.waf_info:
    name: test_waf

- name: obtain all information for a single WAF Regional
  community.aws.waf_info:
    name: test_waf
    waf_regional: true

返回值

常用返回值记录在这里，以下是此模块特有的字段

键

描述

wafs

复杂

与传递的参数匹配的 WAF。

返回：成功

default_action（默认操作）

整数

如果 WebACL 中包含的任何规则都不匹配，则要执行的操作。

返回：始终

示例： "BLOCK"

metric_name（指标名称）

字符串

此 WebACL 的指标的友好名称或描述。

返回：始终

示例： "test_waf_metric"

name

字符串

WebACL 的友好名称或描述。

返回：始终

示例： "test_waf"

rules（规则）

复杂

一个数组，其中包含 WebACL 中每个规则的操作以及规则的优先级。

返回：始终

action（操作）

字符串

如果规则匹配，则要执行的操作。

返回：始终

示例： "BLOCK"

metric_name（指标名称）

字符串

此规则的指标的友好名称或描述。

返回：始终

示例： "ipblockrule"

name

字符串

规则的友好名称或描述。

返回：始终

示例： "ip_block_rule"

predicates（谓词）

列表 / 元素=字符串

谓词列表包含规则中每个 ByteMatchSet、IPSet、SizeConstraintSet、SqlInjectionMatchSet 或 XssMatchSet 对象的谓词。

返回：始终

示例： [{"byte_match_set_id": "47b822b5-abcd-1234-faaf-1234567890", "byte_match_tuples": [{"field_to_match": {"type": "QUERY_STRING"}, "positional_constraint": "STARTS_WITH", "target_string": "bobbins", "text_transformation": "NONE"}], "name": "bobbins", "negated": false, "type": "ByteMatch"}]

作者

  • Mike Mochan (@mmochan)

  • Will Thames (@willthames)