community.aws.waf_rule 模块 – 创建和删除 WAF 规则

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

别名：aws_waf_rule

需求

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

  • 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。

conditions

列表 / 元素=字典

规则中使用的条件列表。 community.aws.waf_condition 可用于创建新的条件。

condition

字符串 / 必需

条件的名称。条件必须已存在。

negated

布尔值 / 必需

是否应否定条件。

选项

  • false

  • true

type

字符串 / 必需

要匹配的规则类型。

选项

  • "byte"

  • "geo"

  • "ip"

  • "size"

  • "sql"

  • "xss"

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

字符串

连接到非默认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

字符串

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

名称只能包含字母数字字符（A-Z、a-z、0-9）；名称不能包含空格。

创建规则后，您无法更改metric_name。

默认为与name相同，但已移除不允许的字符。

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选项互斥。

purge_conditions

布尔值

更新conditions时，是否移除未传递的条件。

选项

  • 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之后的一个版本中移除。

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

字符串

规则是否存在。

选项

  • "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 WAF rule
  community.aws.waf_rule:
    name: my_waf_rule
    conditions:
      - name: my_regex_condition
        type: regex
        negated: false
      - name: my_geo_condition
        type: geo
        negated: false
      - name: my_byte_condition
        type: byte
        negated: true

- name: remove WAF rule
  community.aws.waf_rule:
    name: "my_waf_rule"
    state: absent

返回值

此处记录了常见的返回值 此处，以下是此模块独有的字段

键

描述

rule

complex

WAF规则内容

返回：始终

metric_name

字符串

规则的指标名称。

返回：始终

示例："ansibletest1234rule"

name

字符串

规则的友好名称。

返回：始终

示例："ansible-test-1234_rule"

predicates

complex

规则中使用的条件列表。

返回：始终

data_id

字符串

条件的ID。

返回：始终

示例："8251acdb-526c-42a8-92bc-d3d13e584166"

negated

布尔值

条件的含义是否被否定。

返回：始终

示例：false

type

字符串

条件的类型。

返回：始终

示例："ByteMatch"

rule_id

字符串

WAF规则的ID。

返回：始终

示例："15de0cbc-9204-4e1f-90e6-69b2f415c261"

作者

  • Mike Mochan (@mmochan)

  • Will Thames (@willthames)