community.aws.wafv2_rule_group_info module – wafv2_web_acl_info
Note
This module is part of the community.aws collection (version 10.1.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. You need further requirements to be able to use this module, see Requirements for details.
To use it in a playbook, specify: community.aws.wafv2_rule_group_info.
New in community.aws 1.5.0
Synopsis
- Get informations about existing wafv2 rule groups.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.34.0
- botocore >= 1.34.0
Parameters
Parameter | Comments |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key string | AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. |
aws_ca_bundle path | The location of a CA Bundle to use when validating SSL certificates. The |
aws_config dictionary | A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs boolean | Use a The Choices:
|
endpoint_url aliases: aws_endpoint_url string | URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The |
name string / required | The name of the rule group. |
profile aliases: aws_profile string | A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and session_token options. |
region aliases: aws_region string | The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
scope string / required | Scope of wafv2 rule group. Choices:
|
secret_key aliases: aws_secret_access_key, aws_secret_key string | AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. |
session_token aliases: aws_session_token string | AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The session_token and profile options are mutually exclusive. |
validate_certs boolean | When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
- Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
- The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
- name: rule group info
community.aws.wafv2_rule_group_info:
name: test02
scope: REGIONAL
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
arn string | Rule group arn Returned: Always, as long as the web acl exists Sample: |
capacity integer | Current capacity of the rule group Returned: Always, as long as the rule group exists Sample: |
description string | Description of the rule group Returned: Always, as long as the web acl exists Sample: |
name string | Rule group name Returned: Always, as long as the rule group exists Sample: |
rules list / elements=string | Current rules of the rule group Returned: Always, as long as the rule group exists Sample: |
visibility_config dictionary | Visibility config of the rule group Returned: Always, as long as the rule group exists Sample: |
Collection links
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/wafv2_rule_group_info_module.html
