community.aws.wafv2_rule_group_info 模块 – wafv2_web_acl_info

注意

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

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

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

要在剧本中使用它，请指定：community.aws.wafv2_rule_group_info。

community.aws 1.5.0 中的新增功能

概要

• 获取有关现有 wafv2 规则组的信息。

要求

执行此模块的主机需要以下要求。

• 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 回调将输出到剧本期间进行的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
endpoint_url 别名：ec2_url、aws_endpoint_url、s3_url 字符串	连接到的 URL，而不是默认的 AWS 端点。虽然这可用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的一个版本中移除。 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中移除。
name 字符串 / 必需	规则组的名称。
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月1日后的某个版本中移除。 对EC2_REGION环境变量的支持已弃用，将于2024年12月1日后的某个版本中移除。
范围 字符串 / 必需	WAFv2规则组的范围。 选项 “CLOUDFRONT” “REGIONAL”
secret_key 别名：aws_secret_access_key、aws_secret_key、ec2_secret_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保持一致，aws_secret_access_key别名在5.1.0版本中添加。 ec2_secret_key别名已弃用，将于2024年12月1日后的某个版本中移除。 对EC2_SECRET_KEY环境变量的支持已弃用，将于2024年12月1日后的某个版本中移除。
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月1日后的某个版本中移除。 对EC2_SECRET_KEY和AWS_SECURITY_TOKEN环境变量的支持已弃用，将于2024年12月1日后的某个版本中移除。
validate_certs 布尔值	设置为false时，将不会验证与AWS API通信的SSL证书。 强烈建议不要设置validate_certs=false，作为替代方案，请考虑设置aws_ca_bundle。 选项 false true ← (默认)

备注

注意

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

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

示例

- name: rule group info
  community.aws.wafv2_rule_group_info:
    name: test02
    scope: REGIONAL

返回值

常用返回值已在 此处 记录，以下是此模块独有的字段

键	描述
arn 字符串	规则组arn 返回值：只要web acl存在，就会始终返回。 示例："arn:aws:wafv2:eu-central-1:11111111:regional/rulegroup/test02/6e90c01a-e4eb-43e5-b6aa-b1604cedf7d7"
capacity 整数	规则组的当前容量 返回值：只要规则组存在，就会始终返回。 示例：500
description 字符串	规则组的描述 返回值：只要web acl存在，就会始终返回。 示例："Some rule group description"
name 字符串	规则组名称 返回值：只要规则组存在，就会始终返回。 示例："test02"
rules 列表 / 元素=字符串	规则组的当前规则 返回值：只要规则组存在，就会始终返回。 示例：[{"action": {"allow": {}}, "name": "eins", "priority": 1, "statement": {"ip_set_reference_statement": {"arn": "arn:aws:wafv2:eu-central-1:111111111:regional/ipset/test02/b6978915-c67b-4d1c-8832-2b1bb452143a"}}, "visibility_config": {"cloud_watch_metrics_enabled": true, "metric_name": "fsd", "sampled_requests_enabled": true}}]
visibility_config 字典	规则组的可见性配置 返回值：只要规则组存在，就会始终返回。 示例：{"cloud_watch_metrics_enabled": true, "metric_name": "blub", "sampled_requests_enabled": false}

作者

• Markus Bergholz (@markuman)

资源链接

• 问题追踪
• 代码库 (源代码)
• 沟通