You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WAFRegional::Types::UpdateRateBasedRuleRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb

Overview

Note:

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

{
  rule_id: "ResourceId", # required
  change_token: "ChangeToken", # required
  updates: [ # required
    {
      action: "INSERT", # required, accepts INSERT, DELETE
      predicate: { # required
        negated: false, # required
        type: "IPMatch", # required, accepts IPMatch, ByteMatch, SqlInjectionMatch, GeoMatch, SizeConstraint, XssMatch, RegexMatch
        data_id: "ResourceId", # required
      },
    },
  ],
  rate_limit: 1, # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#change_tokenString

The value returned by the most recent call to GetChangeToken.

Returns:

  • (String)


4916
4917
4918
4919
4920
4921
4922
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4916

class UpdateRateBasedRuleRequest < Struct.new(
  :rule_id,
  :change_token,
  :updates,
  :rate_limit)
  include Aws::Structure
end

#rate_limitInteger

The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

Returns:

  • (Integer)


4916
4917
4918
4919
4920
4921
4922
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4916

class UpdateRateBasedRuleRequest < Struct.new(
  :rule_id,
  :change_token,
  :updates,
  :rate_limit)
  include Aws::Structure
end

#rule_idString

The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

Returns:

  • (String)


4916
4917
4918
4919
4920
4921
4922
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4916

class UpdateRateBasedRuleRequest < Struct.new(
  :rule_id,
  :change_token,
  :updates,
  :rate_limit)
  include Aws::Structure
end

#updatesArray<Types::RuleUpdate>

An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

Returns:



4916
4917
4918
4919
4920
4921
4922
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4916

class UpdateRateBasedRuleRequest < Struct.new(
  :rule_id,
  :change_token,
  :updates,
  :rate_limit)
  include Aws::Structure
end