@Generated(value="software.amazon.awssdk:codegen") public final class RuleGroup extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RuleGroup.Builder,RuleGroup>
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
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.
Modifier and Type | Class and Description |
---|---|
static interface |
RuleGroup.Builder |
Modifier and Type | Method and Description |
---|---|
static RuleGroup.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
metricName()
A friendly name or description for the metrics for this
RuleGroup . |
String |
name()
The friendly name or description for the
RuleGroup . |
String |
ruleGroupId()
A unique identifier for a
RuleGroup . |
List<SdkField<?>> |
sdkFields() |
static Class<? extends RuleGroup.Builder> |
serializableBuilderClass() |
RuleGroup.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final String ruleGroupId()
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.
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.
public final String name()
The friendly name or description for the RuleGroup
. You can't change the name of a
RuleGroup
after you create it.
RuleGroup
. You can't change the name of a
RuleGroup
after you create it.public final String metricName()
A friendly name or description for the metrics for this RuleGroup
. The name can contain only
alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain
whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name
of the metric after you create the RuleGroup
.
RuleGroup
. The name can contain only
alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain
whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change
the name of the metric after you create the RuleGroup
.public RuleGroup.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RuleGroup.Builder,RuleGroup>
public static RuleGroup.Builder builder()
public static Class<? extends RuleGroup.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.