community.aws.waf_web_acl 模块 – 创建和删除 WAF Web ACL
注意
此模块是 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 Classic 的模块，对于 WAF v2，请使用 wafv2_* 模块。
阅读有关 WAF 的 AWS 文档 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
参数
参数 |
注释 |
|---|---|
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 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
用于验证 SSL 证书的 CA 包的位置。 也可以使用 |
|
用于修改 botocore 配置的字典。 参数可以在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
使用 也可以使用 选项
|
|
当请求与关联到 WebACL 的任何规则对象中指定的条件不匹配时，您希望 AWS WAF 采取的操作。 选项
|
|
连接到而不是默认 AWS 端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以按优先级降序使用 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
此 WebACL 的指标的友好名称或描述。 名称只能包含字母数字字符 (A-Z, a-z, 0-9)；名称不能包含空格。 创建 WebACL 后，您无法更改 metric_name。 指标名称将默认为 name，并删除不允许的字符。 |
|
要管理的 Web 应用程序防火墙 ACL 的名称。 |
|
用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。 |
|
是否删除未随 rules 传递的规则。 选项
|
|
要使用的 AWS 区域。 对于诸如 IAM、Route53 和 CloudFront 等全局服务，region 会被忽略。 也可以使用 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。
对 |
|
Web ACL 将强制执行的规则列表。 |
|
要执行的动作。 |
|
规则的名称。 |
|
动作的优先级。优先级必须是唯一的。较低的优先级首先被评估。 |
|
规则的类型。 选项
|
|
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。 也可以按优先级递减顺序使用 secret_key 和 profile 选项互斥。 aws_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 ec2_secret_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减顺序使用 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 之后的版本中删除。 对 |
|
Web ACL 应该是存在还是不存在。 选项
|
|
当设置为 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项
|
|
是否使用 选项
|
注释
注意
注意：对于模块，环境变量和配置文件是从 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 将采取的默认操作。 返回: 始终 示例: |
|
用作标识符的度量标准名称。 返回: 始终 示例: |
|
Web ACL 的友好名称。 返回: 始终 示例: |
|
规则列表。 返回: 始终 |
|
当规则匹配时，WAF 采取的动作。 返回: 始终 示例: |
|
规则的优先级编号（较小的数字先运行）。 返回: 始终 示例: |
|
规则 ID。 返回: 始终 示例: |
|
规则类型（REGULAR 或 RATE_BASED）。 返回: 始终 示例: |
|
Web ACL 的唯一标识符。 返回: 始终 示例: |