com.amazonaws.services.wafv2.model

Class CaptchaAction

java.lang.Object

com.amazonaws.services.wafv2.model.CaptchaAction

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CaptchaAction
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CaptchaAction()

Method Summary

Modifier and Type	Method and Description
CaptchaAction	clone()
boolean	equals(Object obj)
CustomRequestHandling	getCustomRequestHandling() Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCustomRequestHandling(CustomRequestHandling customRequestHandling) Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.
String	toString() Returns a string representation of this object.
CaptchaAction	withCustomRequestHandling(CustomRequestHandling customRequestHandling) Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CaptchaAction

public CaptchaAction()

Method Detail

setCustomRequestHandling

public void setCustomRequestHandling(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.

Parameters:

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.

getCustomRequestHandling

public CustomRequestHandling getCustomRequestHandling()

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.

withCustomRequestHandling

public CaptchaAction withCustomRequestHandling(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CaptchaAction clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.