Struct RuleGroupReferenceStatement

#[non_exhaustive]
pub struct RuleGroupReferenceStatement {
    pub arn: String,
    pub excluded_rules: Option<Vec<ExcludedRule>>,
    pub rule_action_overrides: Option<Vec<RuleActionOverride>>,
}

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.

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.

arn: String

The Amazon Resource Name (ARN) of the entity.

excluded_rules: Option<Vec<ExcludedRule>>

Rules in the referenced rule group whose actions are set to Count.

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

rule_action_overrides: Option<Vec<RuleActionOverride>>

Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

Implementations

impl RuleGroupReferenceStatement

pub fn arn(&self) -> &str

The Amazon Resource Name (ARN) of the entity.

pub fn excluded_rules(&self) -> &[ExcludedRule]

Rules in the referenced rule group whose actions are set to Count.

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .excluded_rules.is_none().

pub fn rule_action_overrides(&self) -> &[RuleActionOverride]

Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .rule_action_overrides.is_none().

impl RuleGroupReferenceStatement

pub fn builder() -> RuleGroupReferenceStatementBuilder

Creates a new builder-style object to manufacture RuleGroupReferenceStatement.

Trait Implementations

impl Clone for RuleGroupReferenceStatement

fn clone(&self) -> RuleGroupReferenceStatement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuleGroupReferenceStatement

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

Formats the value using the given formatter.

impl PartialEq for RuleGroupReferenceStatement

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RuleGroupReferenceStatement