Class: AWSCDK::WAFv2::CfnWebACL::RuleGroupReferenceStatementProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
wa_fv2/cfn_web_acl.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:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arn:, excluded_rules: nil, rule_action_overrides: nil) ⇒ RuleGroupReferenceStatementProperty

Returns a new instance of RuleGroupReferenceStatementProperty.

Parameters:



5637
5638
5639
5640
5641
5642
5643
5644
 
# File 'wa_fv2/cfn_web_acl.rb', line 5637

def initialize(arn:, excluded_rules: nil, rule_action_overrides: nil)
  @arn = arn
  Jsii::Type.check_type(@arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  @excluded_rules = excluded_rules
  Jsii::Type.check_type(@excluded_rules, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfd2FmdjIuQ2ZuV2ViQUNMLkV4Y2x1ZGVkUnVsZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "excludedRules") unless @excluded_rules.nil?
  @rule_action_overrides = rule_action_overrides
  Jsii::Type.check_type(@rule_action_overrides, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfd2FmdjIuQ2ZuV2ViQUNMLlJ1bGVBY3Rpb25PdmVycmlkZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "ruleActionOverrides") unless @rule_action_overrides.nil?
end

Instance Attribute Details

#arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the entity.

Returns:

  • (String)

See Also:



5650
5651
5652
 
# File 'wa_fv2/cfn_web_acl.rb', line 5650

def arn
  @arn
end

#excluded_rules ⇒ AWSCDK::IResolvable, ... (readonly)

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 .

Returns:

See Also:



5657
5658
5659
 
# File 'wa_fv2/cfn_web_acl.rb', line 5657

def excluded_rules
  @excluded_rules
end

#rule_action_overrides ⇒ AWSCDK::IResolvable, ... (readonly)

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.

Verify the rule names in your overrides carefully. With managed rule groups, AWS WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.

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:

See Also:



5668
5669
5670
 
# File 'wa_fv2/cfn_web_acl.rb', line 5668

def rule_action_overrides
  @rule_action_overrides
end

Class Method Details

.jsii_properties ⇒ Object 



5670
5671
5672
5673
5674
5675
5676
 
# File 'wa_fv2/cfn_web_acl.rb', line 5670

def self.jsii_properties
  {
    :arn => "arn",
    :excluded_rules => "excludedRules",
    :rule_action_overrides => "ruleActionOverrides",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



5678
5679
5680
5681
5682
5683
5684
5685
5686
 
# File 'wa_fv2/cfn_web_acl.rb', line 5678

def to_jsii
  result = {}
  result.merge!({
    "arn" => @arn,
    "excludedRules" => @excluded_rules,
    "ruleActionOverrides" => @rule_action_overrides,
  })
  result.compact
end