Package software.amazon.awssdk.services.wafv2.model

Class RuleAction

java.lang.Object

software.amazon.awssdk.services.wafv2.model.RuleAction

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RuleAction.Builder

Method Summary

Modifier and Type	Method	Description
AllowAction	allow()	Instructs WAF to allow the web request.
BlockAction	block()	Instructs WAF to block the web request.
static RuleAction.Builder	builder()
CaptchaAction	captcha()	Instructs WAF to run a CAPTCHA check against the web request.
ChallengeAction	challenge()	Instructs WAF to run a Challenge check against the web request.
CountAction	count()	Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RuleAction.Builder>	serializableBuilderClass()
RuleAction.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

block

public final BlockAction block()

Instructs WAF to block the web request.

Returns:

Instructs WAF to block the web request.

allow

public final AllowAction allow()

Instructs WAF to allow the web request.

Returns:

Instructs WAF to allow the web request.

count

public final CountAction count()

Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

Returns:

Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

captcha

public final CaptchaAction captcha()

Instructs WAF to run a CAPTCHA check against the web request.

Returns:

Instructs WAF to run a CAPTCHA check against the web request.

challenge

public final ChallengeAction challenge()

Instructs WAF to run a Challenge check against the web request.

Returns:

Instructs WAF to run a Challenge check against the web request.

toBuilder

public RuleAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuleAction.Builder,RuleAction>

builder

public static RuleAction.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo