community.aws.aws_waf_rule – Create and delete WAF Rules

Note

This plugin is part of the community.aws collection.

To install it use: ansible-galaxy collection install community.aws.

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

New in version 1.0.0: of community.aws

Synopsis

Requirements

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

  • python >= 2.6

  • boto

Parameters

Parameter Choices/Defaults Comments
aws_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.

aliases: ec2_access_key, access_key
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.
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
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.

aliases: ec2_secret_key, secret_key
conditions
list / elements=dictionary
List of conditions used in the rule. community.aws.aws_waf_condition can be used to create new conditions.
condition
string / required
The name of the condition. The condition must already exist.
negated
boolean / required
    Choices:
  • no
  • yes
Whether the condition should be negated.
type
string / required
    Choices:
  • byte
  • geo
  • ip
  • size
  • sql
  • xss
The type of rule to match.
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
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.
ec2_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.

aliases: aws_endpoint_url, endpoint_url
metric_name
string
A friendly name or description for the metrics for the rule.
The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace.
You can't change metric_name after you create the rule.
Defaults to the same as name with disallowed characters removed.
name
string / required
Name of the Web Application Firewall rule.
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.

aliases: aws_profile
purge_conditions
boolean
    Choices:
  • no ←
  • yes
Whether or not to remove conditions that are not passed when updating `conditions`.
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

aliases: aws_region, ec2_region
security_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.

aliases: aws_security_token, access_token
state
string
    Choices:
  • present ←
  • absent
Whether the rule should be present or absent.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
waf_regional
boolean
    Choices:
  • no ←
  • yes
Whether to use waf-regional module.

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 WAF rule
  community.aws.aws_waf_rule:
    name: my_waf_rule
    conditions:
      - name: my_regex_condition
        type: regex
        negated: no
      - name: my_geo_condition
        type: geo
        negated: no
      - name: my_byte_condition
        type: byte
        negated: yes

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
rule
complex
always
WAF rule contents

 
metric_name
string
always
Metric name for the rule.

Sample:
ansibletest1234rule
 
name
string
always
Friendly name for the rule.

Sample:
ansible-test-1234_rule
 
predicates
complex
always
List of conditions used in the rule.

   
data_id
string
always
ID of the condition.

Sample:
8251acdb-526c-42a8-92bc-d3d13e584166
   
negated
boolean
always
Whether the sense of the condition is negated.

   
type
string
always
type of the condition.

Sample:
ByteMatch
 
rule_id
string
always
ID of the WAF rule.

Sample:
15de0cbc-9204-4e1f-90e6-69b2f415c261


Authors

  • Mike Mochan (@mmochan)

  • Will Thames (@willthames)