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

Class WafAction

java.lang.Object

software.amazon.awssdk.services.waf.model.WafAction

All Implemented Interfaces:

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

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

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.

For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WafAction.Builder

Method Summary

Modifier and Type	Method	Description
static WafAction.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends WafAction.Builder>	serializableBuilderClass()
WafAction.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
WafActionType	type()	Specifies how you want AWS WAF to respond to requests that match the settings in a Rule.
String	typeAsString()	Specifies how you want AWS WAF to respond to requests that match the settings in a Rule.

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

type

public final WafActionType type()

Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

• ALLOW: AWS WAF allows requests

• BLOCK: AWS WAF blocks requests

• COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

If the service returns an enum value that is not available in the current SDK version, type will return WafActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

• ALLOW: AWS WAF allows requests

• BLOCK: AWS WAF blocks requests

• COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

See Also:

WafActionType

typeAsString

public final String typeAsString()

Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

• ALLOW: AWS WAF allows requests

• BLOCK: AWS WAF blocks requests

• COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

If the service returns an enum value that is not available in the current SDK version, type will return WafActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

• ALLOW: AWS WAF allows requests

• BLOCK: AWS WAF blocks requests

• COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

See Also:

WafActionType

toBuilder

public WafAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WafAction.Builder,WafAction>

builder

public static WafAction.Builder builder()

serializableBuilderClass

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