Skip to main content

rule_group_tags

Expands all tag keys and values for rule_groups in a region

Overview

Namerule_group_tags
TypeResource
DescriptionContains 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.
Idaws.wafv2.rule_group_tags

Fields

NameDatatypeDescription
arnstring
capacityinteger
descriptionstringDescription of the entity.
namestringName of the WebACL.
idstringId of the WebACL
scopestringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
rulesarrayCollection of Rules.
visibility_configobjectVisibility Metric of the WebACL.
label_namespacestringName of the Label.
custom_response_bodiesobjectCustom response key and body map.
available_labelsarrayCollection of Available Labels.
consumed_labelsarrayCollection of Consumed Labels.
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all rule_groups in a region.

SELECT
region,
arn,
capacity,
description,
name,
id,
scope,
rules,
visibility_config,
label_namespace,
custom_response_bodies,
available_labels,
consumed_labels,
tag_key,
tag_value
FROM aws.wafv2.rule_group_tags
;

Permissions

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