Struct aws_sdk_wafv2::types::ManagedRuleGroupStatement

#[non_exhaustive]
pub struct ManagedRuleGroupStatement {
    pub vendor_name: String,
    pub name: String,
    pub version: Option<String>,
    pub excluded_rules: Option<Vec<ExcludedRule>>,
    pub scope_down_statement: Option<Box<Statement>>,
    pub managed_rule_group_configs: Option<Vec<ManagedRuleGroupConfig>>,
    pub rule_action_overrides: Option<Vec<RuleActionOverride>>,
}

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

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

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.

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.

vendor_name: String

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

name: String

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

version: Option<String>

The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

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.

scope_down_statement: Option<Box<Statement>>

An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

managed_rule_group_configs: Option<Vec<ManagedRuleGroupConfig>>

Additional information that's used by a managed rule group. Many managed rule groups don't require this.

The rule groups used for intelligent threat mitigation require additional configuration:

• Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields.

• Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password.

• Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

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 ManagedRuleGroupStatement

pub fn vendor_name(&self) -> &str

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

pub fn name(&self) -> &str

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

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

The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

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 scope_down_statement(&self) -> Option<&Statement>

An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

pub fn managed_rule_group_configs(&self) -> &[ManagedRuleGroupConfig]

Additional information that's used by a managed rule group. Many managed rule groups don't require this.

The rule groups used for intelligent threat mitigation require additional configuration:

• Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields.

• Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password.

• Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .managed_rule_group_configs.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 ManagedRuleGroupStatement

pub fn builder() -> ManagedRuleGroupStatementBuilder

Creates a new builder-style object to manufacture ManagedRuleGroupStatement.

Trait Implementations

impl Clone for ManagedRuleGroupStatement

fn clone(&self) -> ManagedRuleGroupStatement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ManagedRuleGroupStatement

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

Formats the value using the given formatter.

impl PartialEq for ManagedRuleGroupStatement

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

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

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

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

impl StructuralPartialEq for ManagedRuleGroupStatement