Class: Aws::WAFRegional::Types::RuleGroupUpdate

Inherits:

Struct

Object
Struct
Aws::WAFRegional::Types::RuleGroupUpdate

show all

Defined in:: gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb

Overview

Note:

When making an API call, you may pass RuleGroupUpdate data as a hash:

{
  action: "INSERT", # required, accepts INSERT, DELETE
  activated_rule: { # required
    priority: 1, # required
    rule_id: "ResourceId", # required
    action: {
      type: "BLOCK", # required, accepts BLOCK, ALLOW, COUNT
    },
    override_action: {
      type: "NONE", # required, accepts NONE, COUNT
    },
    type: "REGULAR", # accepts REGULAR, RATE_BASED, GROUP
    excluded_rules: [
      {
        rule_id: "ResourceId", # required
      },
    ],
  },
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies an ActivatedRule and indicates whether you want to add it to a RuleGroup or delete it from a RuleGroup.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#action ⇒ String
Specify INSERT to add an ActivatedRule to a RuleGroup.
#activated_rule ⇒ Types::ActivatedRule
The ActivatedRule object specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

Instance Attribute Details

#action ⇒ `String`

Specify INSERT to add an ActivatedRule to a RuleGroup. Use DELETE to remove an ActivatedRule from a RuleGroup.

Returns:

(String)

# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 5203

class RuleGroupUpdate < Struct.new(
  :action,
  :activated_rule)
  SENSITIVE = []
  include Aws::Structure
end

#activated_rule ⇒ `Types::ActivatedRule`

The ActivatedRule object specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).