Package software.amazon.awssdk.services.securityhub.model

Class AwsWafv2RulesDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsWafv2RulesDetails

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class AwsWafv2RulesDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsWafv2RulesDetails.Builder,AwsWafv2RulesDetails>

Provides details about rules in a rule group. A rule identifies web requests that you want to allow, block, or count. Each rule includes one top-level Statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AwsWafv2RulesDetails.Builder

Method Summary

Modifier and Type	Method	Description
AwsWafv2RulesActionDetails	action()	The action that WAF should take on a web request when it matches the rule statement.
static AwsWafv2RulesDetails.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the rule.
String	overrideAction()	The action to use in the place of the action that results from the rule group evaluation.
Integer	priority()	If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsWafv2RulesDetails.Builder>	serializableBuilderClass()
AwsWafv2RulesDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
AwsWafv2VisibilityConfigDetails	visibilityConfig()	Defines and enables Amazon CloudWatch metrics and web request sample collection.

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

action

public final AwsWafv2RulesActionDetails action()

The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

Returns:

The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

name

public final String name()

The name of the rule.

Returns:

The name of the rule.

overrideAction

public final String overrideAction()

The action to use in the place of the action that results from the rule group evaluation.

Returns:

The action to use in the place of the action that results from the rule group evaluation.

priority

public final Integer priority()

If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

Returns:

If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

visibilityConfig

public final AwsWafv2VisibilityConfigDetails visibilityConfig()

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Returns:

Defines and enables Amazon CloudWatch metrics and web request sample collection.

toBuilder

public AwsWafv2RulesDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsWafv2RulesDetails.Builder,AwsWafv2RulesDetails>

builder

public static AwsWafv2RulesDetails.Builder builder()

serializableBuilderClass

public static Class<? extends AwsWafv2RulesDetails.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