amazonka-wafv2-2.0: Amazon WAFV2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WAFV2.Types.ChallengeAction

Description

 
Synopsis

Documentation

data ChallengeAction Source #

Specifies that WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session:

  • If the request includes a valid, unexpired challenge 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 challenge token, WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

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

    • The header x-amzn-waf-action with a value of challenge.
    • The HTTP status code 202 Request Accepted.
    • If the request contains an Accept header with a value of text/html, the response includes a JavaScript page interstitial with a challenge script.

    Challenges run silent browser interrogations in the background, and don't generally affect the end user experience.

    A challenge enforces token acquisition using an interstitial JavaScript challenge that inspects the client session for legitimate behavior. The challenge blocks bots or at least increases the cost of operating sophisticated bots.

    After the client session successfully responds to the challenge, it receives a new token from WAF, which the challenge script uses to resubmit the original request.

You can configure the expiration time in the ChallengeConfig 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: newChallengeAction smart constructor.

Constructors

ChallengeAction' 

Fields

Instances

Instances details
FromJSON ChallengeAction Source # 
Instance details

Defined in Amazonka.WAFV2.Types.ChallengeAction

ToJSON ChallengeAction Source # 
Instance details

Defined in Amazonka.WAFV2.Types.ChallengeAction

Generic ChallengeAction Source # 
Instance details

Defined in Amazonka.WAFV2.Types.ChallengeAction

Associated Types

type Rep ChallengeAction :: Type -> Type #

Read ChallengeAction Source # 
Instance details

Defined in Amazonka.WAFV2.Types.ChallengeAction

Show ChallengeAction Source # 
Instance details

Defined in Amazonka.WAFV2.Types.ChallengeAction

NFData ChallengeAction Source # 
Instance details

Defined in Amazonka.WAFV2.Types.ChallengeAction

Methods

rnf :: ChallengeAction -> () #

Eq ChallengeAction Source # 
Instance details

Defined in Amazonka.WAFV2.Types.ChallengeAction

Hashable ChallengeAction Source # 
Instance details

Defined in Amazonka.WAFV2.Types.ChallengeAction

type Rep ChallengeAction Source # 
Instance details

Defined in Amazonka.WAFV2.Types.ChallengeAction

type Rep ChallengeAction = D1 ('MetaData "ChallengeAction" "Amazonka.WAFV2.Types.ChallengeAction" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "ChallengeAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customRequestHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomRequestHandling))))

newChallengeAction :: ChallengeAction Source #

Create a value of ChallengeAction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customRequestHandling:ChallengeAction', challengeAction_customRequestHandling - Defines custom handling for the web request, used when the challenge 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.

challengeAction_customRequestHandling :: Lens' ChallengeAction (Maybe CustomRequestHandling) Source #

Defines custom handling for the web request, used when the challenge 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.