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

Class CaptchaAction

java.lang.Object

software.amazon.awssdk.services.wafv2.model.CaptchaAction

All Implemented Interfaces:

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

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

Specifies that WAF should run a CAPTCHA check against the request:

• If the request includes a valid, unexpired CAPTCHA token, WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to proceed to the next rule, similar to a CountAction.

• If the request doesn't include a valid, unexpired token, WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

  WAF generates a response that it sends back to the client, which includes the following:

  • The header x-amzn-waf-action with a value of captcha.

  • The HTTP status code 405 Method Not Allowed.

  • If the request contains an Accept header with a value of text/html, the response includes a CAPTCHA JavaScript page interstitial.

You can configure the expiration time in the CaptchaConfig ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

This action option is available for rules. It isn't available for web ACL default actions.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CaptchaAction.Builder

Method Summary

Modifier and Type	Method	Description
static CaptchaAction.Builder	builder()
final CustomRequestHandling	customRequestHandling()	Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends CaptchaAction.Builder>	serializableBuilderClass()
CaptchaAction.Builder	toBuilder()
final 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 Details

customRequestHandling

public final CustomRequestHandling customRequestHandling()

Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

Returns:

Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

toBuilder

public CaptchaAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CaptchaAction.Builder,CaptchaAction>

builder

public static CaptchaAction.Builder builder()

serializableBuilderClass

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