Struct aws_sdk_wafv2::model::RuleGroup

#[non_exhaustive]
pub struct RuleGroup {
    pub name: Option<String>,
    pub id: Option<String>,
    pub capacity: i64,
    pub arn: Option<String>,
    pub description: Option<String>,
    pub rules: Option<Vec<Rule>>,
    pub visibility_config: Option<VisibilityConfig>,
    pub label_namespace: Option<String>,
    pub custom_response_bodies: Option<HashMap<String, CustomResponseBody>>,
    pub available_labels: Option<Vec<LabelSummary>>,
    pub consumed_labels: Option<Vec<LabelSummary>>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the rule group. You cannot change the name of a rule group after you create it.

id: Option<String>

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.

capacity: i64

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.

arn: Option<String>

The Amazon Resource Name (ARN) of the entity.

description: Option<String>

A description of the rule group that helps with identification.

rules: Option<Vec<Rule>>

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.

visibility_config: Option<VisibilityConfig>

Defines and enables Amazon CloudWatch metrics and web request sample collection.

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

  awswaf: :rulegroup: :

• 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:

  :

custom_response_bodies: Option<HashMap<String, CustomResponseBody>>

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 in the WAF Developer Guide.

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

available_labels: Option<Vec<LabelSummary>>

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.

consumed_labels: Option<Vec<LabelSummary>>

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.

Implementations

impl RuleGroup

pub fn name(&self) -> Option<&str>

The name of the rule group. You cannot change the name of a rule group after you create it.

pub fn id(&self) -> Option<&str>

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.

pub fn capacity(&self) -> i64

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.

pub fn arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the entity.

pub fn description(&self) -> Option<&str>

A description of the rule group that helps with identification.

pub fn rules(&self) -> Option<&[Rule]>

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.

pub fn visibility_config(&self) -> Option<&VisibilityConfig>

Defines and enables Amazon CloudWatch metrics and web request sample collection.

pub fn label_namespace(&self) -> Option<&str>

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: :rulegroup: :

• 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:

  :

pub fn custom_response_bodies(
    &self
) -> Option<&HashMap<String, CustomResponseBody>>

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 in the WAF Developer Guide.

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

pub fn available_labels(&self) -> Option<&[LabelSummary]>

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.

pub fn consumed_labels(&self) -> Option<&[LabelSummary]>

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.

impl RuleGroup

pub fn builder() -> Builder

Creates a new builder-style object to manufacture RuleGroup

Trait Implementations

impl Clone for RuleGroup

fn clone(&self) -> RuleGroup

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RuleGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<RuleGroup> for RuleGroup

fn eq(&self, other: &RuleGroup) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RuleGroup) -> bool

This method tests for !=.

impl StructuralPartialEq for RuleGroup