Struct aws_sdk_wafv2::types::CaptchaAction

#[non_exhaustive]
pub struct CaptchaAction {
    pub custom_request_handling: Option<CustomRequestHandling>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

custom_request_handling: Option<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.

Implementations

impl CaptchaAction

pub fn custom_request_handling(&self) -> Option<&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.

impl CaptchaAction

pub fn builder() -> CaptchaActionBuilder

Creates a new builder-style object to manufacture CaptchaAction.

Trait Implementations

impl Clone for CaptchaAction

fn clone(&self) -> CaptchaAction

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CaptchaAction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CaptchaAction

fn eq(&self, other: &CaptchaAction) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CaptchaAction