You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.aws.wafv2_web_acl – wafv2_web_acl

Note

This plugin is part of the community.aws collection (version 1.5.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.

To use it in a playbook, specify: community.aws.wafv2_web_acl.

New in version 1.5.0: of community.aws

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis 

Create, modify or delete a wafv2 web acl.

Requirements 

The below requirements are needed on the host that executes this module.

boto
boto3
botocore
python >= 2.6

Parameters 

Parameter	Comments
aws_access_key aliases: ec2_access_key, access_key string	AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aws_ca_bundle path	The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally.
aws_config dictionary	A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Only the ‘user_agent’ key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key aliases: ec2_secret_key, secret_key string	AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
cloudwatch_metrics boolean	Enable cloudwatch metric for wafv2 web acl. Choices: no yes ← (default)
debug_botocore_endpoint_logs boolean	Use a botocore.endpoint logger to parse the unique (rather than total) “resource:action” API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. Choices: no ← (default) yes
default_action string	Default action of the wafv2 web acl. Choices: Block Allow
description string	Description of wafv2 web acl.
ec2_url aliases: aws_endpoint_url, endpoint_url string	Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
metric_name string	Name of cloudwatch metrics. If not given and cloudwatch_metrics is enabled, the name of the web acl itself will be taken.
name string / required	The name of the web acl.
profile aliases: aws_profile string	Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
purge_rules boolean	When set to `no`, keep the existing load balancer rules in place. Will modify and add, but will not delete. Choices: no yes ← (default)
region aliases: aws_region, ec2_region string	The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
rules list / elements=dictionary	The Rule statements used to identify the web requests that you want to allow, block, or count.
action dictionary	Wether a rule is blocked, allowed or counted.
name string	The name of the wafv2 rule
priority integer	The rule priority
statement dictionary	Rule configuration.
visibility_config dictionary	Visibility of single wafv2 rule.
sampled_requests boolean	Whether to store a sample of the web requests, true or false. Choices: no ← (default) yes
scope string / required	Scope of wafv2 web acl. Choices: CLOUDFRONT REGIONAL
security_token aliases: aws_security_token, access_token string	AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
state string / required	Whether the rule is present or absent. Choices: present absent
tags dictionary	tags for wafv2 web acl.
validate_certs boolean	When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0. Choices: no yes ← (default)

Notes 

Note

If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples 

- name: create web acl
  community.aws.wafv2_web_acl:
    name: test05
    state: present
    description: hallo eins
    scope: REGIONAL
    default_action: Allow
    sampled_requests: no
    cloudwatch_metrics: yes
    metric_name: blub
    rules:
      - name: zwei
        priority: 2
        action:
          block: {}
        visibility_config:
          sampled_requests_enabled: yes
          cloud_watch_metrics_enabled: yes
          metric_name: ddos
        statement:
          xss_match_statement:
            field_to_match:
              body: {}
            text_transformations:
              - type: NONE
                priority: 0
      - name: admin_protect
        priority: 1
        override_action:
          none: {}
        visibility_config:
          sampled_requests_enabled: yes
          cloud_watch_metrics_enabled: yes
          metric_name: fsd
        statement:
          managed_rule_group_statement:
            vendor_name: AWS
            name: AWSManagedRulesAdminProtectionRuleSet
    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
arn string	web acl arn Returned: Always, as long as the web acl exists Sample: “arn:aws:wafv2:eu-central-1:11111111:regional/webacl/test05/318c1ab9-fa74-4b3b-a974-f92e25106f61”
capacity integer	Current capacity of the web acl Returned: Always, as long as the web acl exists Sample: 140
description string	Description of the web acl Returned: Always, as long as the web acl exists Sample: “Some web acl description”
name string	Web acl name Returned: Always, as long as the web acl exists Sample: “test02”
rules list / elements=string	Current rules of the web acl Returned: Always, as long as the web acl exists Sample: [{“name”: “admin_protect”, “override_action”: {“none”: {}}, “priority”: 1, “statement”: {“managed_rule_group_statement”: {“name”: “AWSManagedRulesAdminProtectionRuleSet”, “vendor_name”: “AWS”}}, “visibility_config”: {“cloud_watch_metrics_enabled”: true, “metric_name”: “admin_protect”, “sampled_requests_enabled”: true}}]
visibility_config dictionary	Visibility config of the web acl Returned: Always, as long as the web acl exists Sample: {“cloud_watch_metrics_enabled”: true, “metric_name”: “blub”, “sampled_requests_enabled”: false}

Authors

Markus Bergholz (@markuman)

community.aws.wafv2_web_acl – wafv2_web_acl

Synopsis

Requirements

Parameters

Notes

Examples

Return Values