Package software.amazon.awssdk.services.waf.model

Class RuleGroup

java.lang.Object

software.amazon.awssdk.services.waf.model.RuleGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RuleGroup.Builder,RuleGroup>

@Generated("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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RuleGroup.Builder

Method Summary

Modifier and Type	Method	Description
static RuleGroup.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

ruleGroupId

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.

Returns:

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.

name

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.

Returns:

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

metricName

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.

Returns:

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.

toBuilder

public RuleGroup.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuleGroup.Builder,RuleGroup>

builder

public static RuleGroup.Builder builder()

serializableBuilderClass

public static Class<? extends RuleGroup.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo