subscribed_rule_groups
Creates, updates, deletes, gets or lists a subscribed_rule_groups resource.
Overview
| Name | subscribed_rule_groups |
| Type | Resource |
| Id | aws.waf.subscribed_rule_groups |
Fields
The following fields are returned by SELECT queries:
- list_subscribed_rule_groups
| Name | Datatype | Description |
|---|---|---|
metric_name | string | A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup. (pattern: <code>.\S.</code>) |
name | string | A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it. (pattern: <code>.\S.</code>) |
rule_group_id | string | A unique identifier for a RuleGroup. (pattern: <code>.\S.</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_subscribed_rule_groups | select | region | This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RuleGroup objects that you are subscribed to. |
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
- list_subscribed_rule_groups
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RuleGroup objects that you are subscribed to.
SELECT
metric_name,
name,
rule_group_id
FROM aws.waf.subscribed_rule_groups
WHERE region = '{{ region }}' -- required
;