Class CaptchaAction
- All Implemented Interfaces:
Serializable
,SdkPojo
,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 aCountAction
. -
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 ofcaptcha
. -
The HTTP status code
405 Method Not Allowed
. -
If the request contains an
Accept
header with a value oftext/html
, the response includes aCAPTCHA
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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CaptchaAction.Builder
builder()
final CustomRequestHandling
Defines custom handling for the web request, used when theCAPTCHA
inspection determines that the request's token is valid and unexpired.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends CaptchaAction.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CaptchaAction.Builder,
CaptchaAction> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-