class Aws::WAFV2::Types::RuleGroup

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

@!attribute [rw] name

The name of the rule group. You cannot change the name of a rule
group after you create it.
@return [String]

@!attribute [rw] id

A unique identifier for the rule group. This ID is returned in the
responses to create and list commands. You provide it to operations
like update and delete.
@return [String]

@!attribute [rw] capacity

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot
change it after creation. When you add or modify the rules in a rule
group, WAF enforces this limit. You can check the capacity for a set
of rules using CheckCapacity.

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. The WCU limit
for web ACLs is 1,500.
@return [Integer]

@!attribute [rw] arn

The Amazon Resource Name (ARN) of the entity.
@return [String]

@!attribute [rw] description

A description of the rule group that helps with identification.
@return [String]

@!attribute [rw] rules

The Rule statements used to identify the web requests that you want
to allow, block, or count. Each rule includes one top-level
statement that WAF uses to identify matching web requests, and
parameters that govern how WAF handles them.
@return [Array<Types::Rule>]

@!attribute [rw] visibility_config

Defines and enables Amazon CloudWatch metrics and web request sample
collection.
@return [Types::VisibilityConfig]

@!attribute [rw] label_namespace

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 your rule groups is
  the following:

  `awswaf:<account ID>:rulegroup:<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>`
@return [String]

@!attribute [rw] custom_response_bodies

A map of custom response keys and content bodies. When you create a
rule with a block action, you can send a custom response to the web
request. You define these for the rule group, and then use them in
the rules that you define in the rule group.

For information about customizing web requests and responses, see
[Customizing web requests and responses in WAF][1] in the [WAF
Developer Guide][2].

For information about the limits on count and size for custom
request and response settings, see [WAF quotas][3] in the [WAF
Developer Guide][2].

[1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
[2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
[3]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
@return [Hash<String,Types::CustomResponseBody>]

@!attribute [rw] available_labels

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.
@return [Array<Types::LabelSummary>]

@!attribute [rw] consumed_labels

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.
@return [Array<Types::LabelSummary>]

@see docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/RuleGroup AWS API Documentation

Constants

SENSITIVE