Class: Aws::WAF::Types::UpdateRuleGroupRequest

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

Overview

Note:

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

{
  rule_group_id: "ResourceId", # required
  updates: [ # required
    {
      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
          },
        ],
      },
    },
  ],
  change_token: "ChangeToken", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#change_tokenString

The value returned by the most recent call to GetChangeToken.

Returns:

  • (String)

6481
6482
6483
6484
6485
6486
6487
# File 'lib/aws-sdk-waf/types.rb', line 6481

class UpdateRuleGroupRequest < Struct.new(
  :rule_group_id,
  :updates,
  :change_token)
  SENSITIVE = []
  include Aws::Structure
end

#rule_group_idString

The `RuleGroupId` of the RuleGroup that you want to update. `RuleGroupId` is returned by CreateRuleGroup and by ListRuleGroups.

Returns:

  • (String)

6481
6482
6483
6484
6485
6486
6487
# File 'lib/aws-sdk-waf/types.rb', line 6481

class UpdateRuleGroupRequest < Struct.new(
  :rule_group_id,
  :updates,
  :change_token)
  SENSITIVE = []
  include Aws::Structure
end

#updatesArray<Types::RuleGroupUpdate>

An array of `RuleGroupUpdate` objects that you want to insert into or delete from a RuleGroup.

You can only insert `REGULAR` rules into a rule group.

`ActivatedRule|OverrideAction` applies only when updating or adding a `RuleGroup` to a `WebACL`. In this case you do not use `ActivatedRule|Action`. For all other update requests, `ActivatedRule|Action` is used instead of `ActivatedRule|OverrideAction`.

Returns:


6481
6482
6483
6484
6485
6486
6487
# File 'lib/aws-sdk-waf/types.rb', line 6481

class UpdateRuleGroupRequest < Struct.new(
  :rule_group_id,
  :updates,
  :change_token)
  SENSITIVE = []
  include Aws::Structure
end