managed_rule_groups

Creates, updates, deletes, gets or lists a managed_rule_groups resource.

Overview

Name	managed_rule_groups
Type	Resource
Id	aws.wafv2.managed_rule_groups

Fields

The following fields are returned by SELECT queries:

describe_managed_rule_group

Name	Datatype	Description
available_labels	array	The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.
capacity	integer (int64)	The web ACL capacity units (WCUs) required for this rule group. WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
consumed_labels	array	The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.
label_namespace	string	The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix. The syntax for the label namespace prefix for a managed rule group is the following: awswaf:managed:<vendor>:<rule group name>: When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: <label namespace>:<label from rule> (pattern: <code>^[0-9A-Za-z_-:]+$</code>)
rules	array
sns_topic_arn	string	The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide. (pattern: <code>.\S.</code>)
version_name	string	The managed rule group's version. (pattern: <code>^[\w#:.-/]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_managed_rule_group	select	region		Provides high-level information for a managed rule group, including descriptions of the rules.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_managed_rule_group

Provides high-level information for a managed rule group, including descriptions of the rules.

SELECT
available_labels,
capacity,
consumed_labels,
label_namespace,
rules,
sns_topic_arn,
version_name
FROM aws.wafv2.managed_rule_groups
WHERE region = '{{ region }}' -- required
;