Class: Aws::WAFV2::Types::RuleGroupReferenceStatement

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-wafv2/types.rb

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the entity.

Returns:

  • (String) 


8114
8115
8116
8117
8118
8119
8120
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8114

class RuleGroupReferenceStatement < Struct.new(
  :arn,
  :excluded_rules,
  :rule_action_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#excluded_rules ⇒ Array<Types::ExcludedRule>

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

<note markdown=“1”> Instead of this option, use ‘RuleActionOverrides`. It accepts any valid action setting, including `Count`.

</note>

Returns:



8114
8115
8116
8117
8118
8119
8120
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8114

class RuleGroupReferenceStatement < Struct.new(
  :arn,
  :excluded_rules,
  :rule_action_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#rule_action_overrides ⇒ Array<Types::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.

<note markdown=“1”> Take care to verify the rule names in your overrides. If you provide a rule name that doesn’t match the name of any rule in the rule group, WAF doesn’t return an error and doesn’t apply the override setting.

</note>

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.

Returns:



8114
8115
8116
8117
8118
8119
8120
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8114

class RuleGroupReferenceStatement < Struct.new(
  :arn,
  :excluded_rules,
  :rule_action_overrides)
  SENSITIVE = []
  include Aws::Structure
end