community / community.aws / 3.4.0 / module / aws_waf_rule Create and delete WAF Rules | "added in version" 1.0.0 of community.aws" Authors: Mike Mochan (@mmochan), Will Thames (@willthames)community.aws.aws_waf_rule (3.4.0) — module
Install with ansible-galaxy collection install community.aws:==3.4.0
collections: - name: community.aws version: 3.4.0
Read the AWS documentation for WAF U(https://aws.amazon.com/documentation/waf/).
- 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
name: description: Name of the Web Application Firewall rule. required: true type: str state: choices: - present - absent default: present description: Whether the rule should be present or absent. type: str region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict conditions: description: 'List of conditions used in the rule. M(community.aws.aws_waf_condition) can be used to create new conditions. ' elements: dict suboptions: condition: description: The name of the condition. The condition must already exist. required: true type: str negated: description: Whether the condition should be negated. required: true type: bool type: choices: - byte - geo - ip - size - sql - xss description: The type of rule to match. required: true type: str type: list metric_name: description: - 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 I(metric_name) after you create the rule. - Defaults to the same as I(name) with disallowed characters removed. type: str waf_regional: default: false description: Whether to use waf-regional module. required: false type: bool aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool purge_conditions: default: false description: - Whether or not to remove conditions that are not passed when updating I(conditions). type: bool debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
rule: contains: metric_name: description: Metric name for the rule. returned: always sample: ansibletest1234rule type: str name: description: Friendly name for the rule. returned: always sample: ansible-test-1234_rule type: str predicates: contains: data_id: description: ID of the condition. returned: always sample: 8251acdb-526c-42a8-92bc-d3d13e584166 type: str negated: description: Whether the sense of the condition is negated. returned: always sample: false type: bool type: description: type of the condition. returned: always sample: ByteMatch type: str description: List of conditions used in the rule. returned: always type: complex rule_id: description: ID of the WAF rule. returned: always sample: 15de0cbc-9204-4e1f-90e6-69b2f415c261 type: str description: WAF rule contents returned: always type: complex