rule_groups_list_only

Lists rule_groups in a region or regions, for all properties use rule_groups

Overview

Name	rule_groups_list_only
Type	Resource
Description	Contains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Id	aws.wafv2.rule_groups_list_only

Fields

Name	Datatype	Description
arn	string
capacity	integer
description	string	Description of the entity.
name	string	Name of the WebACL.
id	string	Id of the WebACL
scope	string	Use CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
rules	array	Collection of Rules.
visibility_config	object	Visibility Metric of the WebACL.
tags	array
label_namespace	string	Name of the Label.
custom_response_bodies	object	Custom response key and body map.
available_labels	array	Collection of Available Labels.
consumed_labels	array	Collection of Consumed Labels.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all rule_groups in a region.

SELECT
region,
name,
id,
scope
FROM aws.wafv2.rule_groups_list_only
;

Permissions

For permissions required to operate on the rule_groups_list_only resource, see rule_groups