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

Class: Aws::WAFRegional::Types::Rule

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

Overview

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:

  • An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44

  • A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot.

To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot.

Instance Attribute Summary collapse

Instance Attribute Details

#metric_nameString

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

Returns:

  • (String)


3607
3608
3609
3610
3611
3612
3613
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 3607

class Rule < Struct.new(
  :rule_id,
  :name,
  :metric_name,
  :predicates)
  include Aws::Structure
end

#nameString

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

Returns:

  • (String)


3607
3608
3609
3610
3611
3612
3613
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 3607

class Rule < Struct.new(
  :rule_id,
  :name,
  :metric_name,
  :predicates)
  include Aws::Structure
end

#predicatesArray<Types::Predicate>

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Returns:



3607
3608
3609
3610
3611
3612
3613
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 3607

class Rule < Struct.new(
  :rule_id,
  :name,
  :metric_name,
  :predicates)
  include Aws::Structure
end

#rule_idString

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Returns:

  • (String)


3607
3608
3609
3610
3611
3612
3613
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 3607

class Rule < Struct.new(
  :rule_id,
  :name,
  :metric_name,
  :predicates)
  include Aws::Structure
end