amazonka-wafv2-2.0: Amazon WAFV2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WAFV2.Types.RuleGroupReferenceStatement

Description

 
Synopsis

Documentation

data RuleGroupReferenceStatement Source #

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 can only use a rule group reference statement at the top level inside a web ACL.

See: newRuleGroupReferenceStatement smart constructor.

Constructors

RuleGroupReferenceStatement' 

Fields

  • excludedRules :: Maybe [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.

  • ruleActionOverrides :: Maybe (NonEmpty 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.

  • arn :: Text

    The Amazon Resource Name (ARN) of the entity.

Instances

Instances details
FromJSON RuleGroupReferenceStatement Source # 
Instance details

Defined in Amazonka.WAFV2.Types.RuleGroupReferenceStatement

ToJSON RuleGroupReferenceStatement Source # 
Instance details

Defined in Amazonka.WAFV2.Types.RuleGroupReferenceStatement

Generic RuleGroupReferenceStatement Source # 
Instance details

Defined in Amazonka.WAFV2.Types.RuleGroupReferenceStatement

Associated Types

type Rep RuleGroupReferenceStatement :: Type -> Type #

Read RuleGroupReferenceStatement Source # 
Instance details

Defined in Amazonka.WAFV2.Types.RuleGroupReferenceStatement

Show RuleGroupReferenceStatement Source # 
Instance details

Defined in Amazonka.WAFV2.Types.RuleGroupReferenceStatement

NFData RuleGroupReferenceStatement Source # 
Instance details

Defined in Amazonka.WAFV2.Types.RuleGroupReferenceStatement

Eq RuleGroupReferenceStatement Source # 
Instance details

Defined in Amazonka.WAFV2.Types.RuleGroupReferenceStatement

Hashable RuleGroupReferenceStatement Source # 
Instance details

Defined in Amazonka.WAFV2.Types.RuleGroupReferenceStatement

type Rep RuleGroupReferenceStatement Source # 
Instance details

Defined in Amazonka.WAFV2.Types.RuleGroupReferenceStatement

type Rep RuleGroupReferenceStatement = D1 ('MetaData "RuleGroupReferenceStatement" "Amazonka.WAFV2.Types.RuleGroupReferenceStatement" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "RuleGroupReferenceStatement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "excludedRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExcludedRule])) :*: (S1 ('MetaSel ('Just "ruleActionOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty RuleActionOverride))) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newRuleGroupReferenceStatement Source #

Create a value of RuleGroupReferenceStatement with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:excludedRules:RuleGroupReferenceStatement', ruleGroupReferenceStatement_excludedRules - 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.

$sel:ruleActionOverrides:RuleGroupReferenceStatement', ruleGroupReferenceStatement_ruleActionOverrides - 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.

$sel:arn:RuleGroupReferenceStatement', ruleGroupReferenceStatement_arn - The Amazon Resource Name (ARN) of the entity.

ruleGroupReferenceStatement_excludedRules :: Lens' RuleGroupReferenceStatement (Maybe [ExcludedRule]) Source #

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.

ruleGroupReferenceStatement_ruleActionOverrides :: Lens' RuleGroupReferenceStatement (Maybe (NonEmpty RuleActionOverride)) Source #

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.

ruleGroupReferenceStatement_arn :: Lens' RuleGroupReferenceStatement Text Source #

The Amazon Resource Name (ARN) of the entity.