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(value="software.amazon.awssdk:codegen")
public final class RuleGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RuleGroup.Builder,RuleGroup>

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 and Description
static interface	RuleGroup.Builder

Method Summary

Modifier and Type	Method and Description
static RuleGroup.Builder	builder()
boolean	equals(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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

ruleGroupId

public 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 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 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); the name can't contain whitespace. 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); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup.

toBuilder

public RuleGroup.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RuleGroup.Builder,RuleGroup>

Returns:

a builder for type T

builder

public static RuleGroup.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.