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

Class: Aws::WAFRegional::Types::RuleGroup

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

Overview

A collection of predefined rules that you can add to a web ACL.

Rule groups are subject to the following limits:

  • Three rule groups per account. You can request an increase to this limit by contacting customer support.

  • One rule group per web ACL.

  • Ten rules per rule group.

Instance Attribute Summary collapse

Instance Attribute Details

#metric_nameString

A friendly name or description for the metrics for this RuleGroup. 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 RuleGroup.

Returns:

  • (String)


4054
4055
4056
4057
4058
4059
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4054

class RuleGroup < Struct.new(
  :rule_group_id,
  :name,
  :metric_name)
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


4054
4055
4056
4057
4058
4059
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4054

class RuleGroup < Struct.new(
  :rule_group_id,
  :name,
  :metric_name)
  include Aws::Structure
end

#rule_group_idString

A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

Returns:

  • (String)


4054
4055
4056
4057
4058
4059
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4054

class RuleGroup < Struct.new(
  :rule_group_id,
  :name,
  :metric_name)
  include Aws::Structure
end