community.aws.wafv2_rule_group module – wafv2_web_acl
Note
This module is part of the community.aws collection (version 8.0.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.wafv2_rule_group.
New in community.aws 1.5.0
Synopsis
Create, modify and delete wafv2 rule groups.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
capacity of wafv2 rule group. |
|
Enable cloudwatch metric for wafv2 rule group Choices:
|
|
Use a The Choices:
|
|
Description of wafv2 rule group. |
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Name of cloudwatch metrics. If not given and cloudwatch_metrics is enabled, the name of the rule group itself will be taken. |
|
The name of the rule group. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
When set to Choices:
|
|
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified, even if purge_tags=True. Tag keys beginning with Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
The Rule statements used to identify the web requests that you want to allow, block, or count. |
|
Sampled requests, true or false. Choices:
|
|
Scope of wafv2 rule group. Choices:
|
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Whether the rule is present or absent. Choices:
|
|
A dictionary representing the tags to be applied to the resource. If the tags parameter is not set then tags will not be modified. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
- name: change description
community.aws.wafv2_rule_group:
name: test02
state: present
description: hallo eins zwei
scope: REGIONAL
capacity: 500
rules:
- name: eins
priority: 1
action:
allow: {}
visibility_config:
sampled_requests_enabled: true
cloud_watch_metrics_enabled: true
metric_name: fsd
statement:
ip_set_reference_statement:
arn: "{{ IPSET.arn }}"
cloudwatch_metrics: true
tags:
A: B
C: D
register: out
- name: add rule
community.aws.wafv2_rule_group:
name: test02
state: present
description: hallo eins zwei
scope: REGIONAL
capacity: 500
rules:
- name: eins
priority: 1
action:
allow: {}
visibility_config:
sampled_requests_enabled: true
cloud_watch_metrics_enabled: true
metric_name: fsd
statement:
ip_set_reference_statement:
arn: "{{ IPSET.arn }}"
- name: zwei
priority: 2
action:
block: {}
visibility_config:
sampled_requests_enabled: true
cloud_watch_metrics_enabled: true
metric_name: ddos
statement:
or_statement:
statements:
- byte_match_statement:
search_string: ansible.com
positional_constraint: CONTAINS
field_to_match:
single_header:
name: host
text_transformations:
- type: LOWERCASE
priority: 0
- xss_match_statement:
field_to_match:
body: {}
text_transformations:
- type: NONE
priority: 0
cloudwatch_metrics: true
tags:
A: B
C: D
register: out
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Rule group arn Returned: Always, as long as the web acl exists Sample: |
|
Current capacity of the rule group Returned: Always, as long as the rule group exists Sample: |
|
Description of the rule group Returned: Always, as long as the web acl exists Sample: |
|
Rule group name Returned: Always, as long as the rule group exists Sample: |
|
Current rules of the rule group Returned: Always, as long as the rule group exists Sample: |
|
Visibility config of the rule group Returned: Always, as long as the rule group exists Sample: |