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

Class: Aws::WAF::Types::CreateRateBasedRuleRequest

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

Overview

Note:

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

{
  name: "ResourceName", # required
  metric_name: "MetricName", # required
  rate_key: "IP", # required, accepts IP
  rate_limit: 1, # required
  change_token: "ChangeToken", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#change_tokenString

The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (String)


609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 609

class CreateRateBasedRuleRequest < Struct.new(
  :name,
  :metric_name,
  :rate_key,
  :rate_limit,
  :change_token)
  include Aws::Structure
end

#metric_nameString

A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule.

Returns:

  • (String)


609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 609

class CreateRateBasedRuleRequest < Struct.new(
  :name,
  :metric_name,
  :rate_key,
  :rate_limit,
  :change_token)
  include Aws::Structure
end

#nameString

A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it.

Returns:

  • (String)


609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 609

class CreateRateBasedRuleRequest < Struct.new(
  :name,
  :metric_name,
  :rate_key,
  :rate_limit,
  :change_token)
  include Aws::Structure
end

#rate_keyString

The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

Returns:

  • (String)


609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 609

class CreateRateBasedRuleRequest < Struct.new(
  :name,
  :metric_name,
  :rate_key,
  :rate_limit,
  :change_token)
  include Aws::Structure
end

#rate_limitInteger

The maximum number of requests, which have an identical value in the field that is specified by 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)


609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 609

class CreateRateBasedRuleRequest < Struct.new(
  :name,
  :metric_name,
  :rate_key,
  :rate_limit,
  :change_token)
  include Aws::Structure
end