community.aws.waf_web_acl 模块 – 创建和删除 WAF Web ACLs

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

• 适用于 WAF 经典版，对于 WAF v2，请使用 _wafv2_* 模块。

• 阅读 AWS WAF 文档 https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html。

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

别名：aws_waf_web_acl

要求

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

• 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
default_action 字符串	当请求与与 WebACL 关联的任何规则对象中指定的条件不匹配时，您希望 AWS WAF 执行的操作。 选项 "block" "allow" "count"
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之后的一个版本中移除。
metric_name 字符串	此WebACL指标的友好名称或描述。 名称只能包含字母数字字符（A-Z、a-z、0-9）；名称不能包含空格。 创建WebACL后，您无法更改metric_name。 指标名称默认为name，其中不允许的字符会被去除。
name 字符串 / 必需	要管理的Web应用程序防火墙ACL的名称。
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选项互斥。
purge_rules 布尔值	是否删除未与rules一起传递的规则。 选项 false ← (默认) true
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之后的一个版本中移除。
rules 列表 / 元素=字典	Web ACL将强制执行的规则列表。
action 字符串 / 必需	要执行的操作。
name 字符串 / 必需	规则的名称。
priority 整数 / 必需	操作的优先级。优先级必须唯一。编号较低的优先级将首先进行评估。
type 字符串	规则的类型。 选项 "rate_based" "regular"
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保持一致，在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选项互斥。 在3.2.0版本中添加了别名aws_session_token和session_token，在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之后的一个版本中移除。
state 字符串	Web ACL是否存在。 选项 "present" ← (默认) "absent"
validate_certs 布尔值	设置为false时，将不会验证与AWS API通信的SSL证书。 强烈建议不要设置validate_certs=false，作为替代方案，请考虑改为设置aws_ca_bundle。 选项 false true ← (默认)
waf_regional 布尔值	是否使用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: create web ACL
  community.aws.waf_web_acl:
    name: my_web_acl
    rules:
      - name: my_rule
        priority: 1
        action: block
    default_action: block
    purge_rules: true
    state: present

- name: delete the web acl
  community.aws.waf_web_acl:
    name: my_web_acl
    state: absent

返回值

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

键	描述
web_acl 复杂的	Web ACL的内容。 返回：始终
default_action 字典	如果没有任何规则匹配，则Web ACL采取的默认操作。 返回：始终 示例：{"type": "BLOCK"}
metric_name 字符串	用作标识符的指标名称。 返回：始终 示例："mywebacl"
name 字符串	Web ACL的友好名称。 返回：始终 示例："my web acl"
rules 复杂的	规则列表。 返回：始终
action 复杂的	规则匹配时WAF采取的操作。 返回：始终 示例：{"type": "ALLOW"}
priority 整数	规则的优先级编号（较低的数字优先执行）。 返回：始终 示例：2
rule_id 字符串	规则ID。 返回：始终 示例："a6fc7ab5-287b-479f-8004-7fd0399daf75"
type 字符串	规则类型（REGULAR或RATE_BASED）。 返回：始终 示例："REGULAR"
web_acl_id 字符串	Web ACL的唯一标识符。 返回：始终 示例："10fff965-4b6b-46e2-9d78-24f6d2e2d21c"

作者

• Mike Mochan (@mmochan)

• Will Thames (@willthames)

集合链接

• 问题追踪器
• 代码库（源代码）
• 沟通