community / community.aws / 3.4.0 / module / wafv2_ip_set wafv2_ip_set | "added in version" 1.5.0 of community.aws" Authors: Markus Bergholz (@markuman)community.aws.wafv2_ip_set (3.4.0) — module
Install with ansible-galaxy collection install community.aws:==3.4.0
collections: - name: community.aws version: 3.4.0
Create, modify and delete IP sets for WAFv2.
- name: test ip set wafv2_ip_set: name: test02 state: present description: hallo eins scope: REGIONAL ip_address_version: IPV4 addresses: - 8.8.8.8/32 - 8.8.4.4/32 tags: A: B C: D
name: description: - The name of the IP set. required: true type: str tags: description: - Key value pairs to associate with the resource. - Currently tags are not visible. Nor in the web ui, nor via cli and nor in boto3. required: false type: dict scope: choices: - CLOUDFRONT - REGIONAL description: - Specifies whether this is for an AWS CloudFront distribution or for a regional application, such as API Gateway or Application LoadBalancer. required: true type: str state: choices: - present - absent description: - Whether the rule is present or absent. required: true 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 addresses: description: - Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. - Required when I(state=present). - When I(state=absent) and I(addresses) is defined, only the given IP addresses will be removed from the IP set. The entire IP set itself will stay present. elements: str type: list 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 description: description: - Description of the IP set. required: false type: str 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_addresses: default: true description: - When set to C(no), keep the existing addresses in place. Will modify and add, but will not delete. type: bool ip_address_version: choices: - IPV4 - IPV6 description: - Specifies whether this is an IPv4 or an IPv6 IP set. - Required when I(state=present). type: str 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
addresses: description: Current addresses of the ip set returned: Always, as long as the ip set exists sample: - 8.8.8.8/32 - 8.8.4.4/32 type: list arn: description: IP set arn returned: Always, as long as the ip set exists sample: arn:aws:wafv2:eu-central-1:11111111:regional/ipset/test02/4b007330-2934-4dc5-af24-82dcb3aeb127 type: str description: description: Description of the ip set returned: Always, as long as the ip set exists sample: Some IP set description type: str ip_address_version: description: IP version of the ip set returned: Always, as long as the ip set exists sample: IPV4 type: str name: description: IP set name returned: Always, as long as the ip set exists sample: test02 type: str