aws_waf_facts - Retrieve facts for WAF ACLs, Rule , Conditions and Filters.¶

New in version 2.4.

Synopsis ¶

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

Parameter	Choices/Defaults	Comments
aws_access_key		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. aliases: ec2_access_key, access_key
aws_secret_key		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. aliases: ec2_secret_key, secret_key
ec2_url		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.
name		The name of a Web Application Firewall
profile (added in 1.6)		Uses a boto profile. Only works with boto >= 2.24.0.
region		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 (added in 1.6)		AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token
validate_certs bool (added in 1.5)	Choices: no yes ←	When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

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_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
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

- name: obtain all WAF facts
  aws_waf_facts:

- name: obtain all facts for a single WAF
  aws_waf_facts:
    name: test_waf

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

Key			Returned	Description
wafs complex			success	The WAFs that match the passed arguments
	rules complex		always	An array that contains the action for each Rule in a WebACL , the priority of the Rule
		action string	always	The action to perform if the Rule matches Sample: BLOCK
		predicates list	always	The Predicates list contains a Predicate for each ByteMatchSet, IPSet, SizeConstraintSet, SqlInjectionMatchSet or XssMatchSet object in a Rule Sample: [{'negated': False, 'byte_match_set_id': '47b822b5-abcd-1234-faaf-1234567890', 'byte_match_tuples': [{'text_transformation': 'NONE', 'field_to_match': {'type': 'QUERY_STRING'}, 'target_string': 'bobbins', 'positional_constraint': 'STARTS_WITH'}], 'type': 'ByteMatch', 'name': 'bobbins'}]
		metric_name string	always	A friendly name or description for the metrics for this Rule Sample: ipblockrule
		name string	always	A friendly name or description of the Rule Sample: ip_block_rule
	default_action int		always	The action to perform if none of the Rules contained in the WebACL match. Sample: BLOCK
	name string		always	A friendly name or description of the WebACL Sample: test_waf
	metric_name string		always	A friendly name or description for the metrics for this WebACL Sample: test_waf_metric

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Hint

If you notice any issues in this documentation you can edit this document to improve it.