Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WAFV2.Types.CaptchaAction

Description

Synopsis

data CaptchaAction = CaptchaAction' {
- customRequestHandling :: Maybe CustomRequestHandling
}
newCaptchaAction :: CaptchaAction
captchaAction_customRequestHandling :: Lens' CaptchaAction (Maybe CustomRequestHandling)

Documentation

data CaptchaAction Source #

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: newCaptchaAction smart constructor.

Constructors

CaptchaAction'
Fields customRequestHandling :: Maybe 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.

Instances

Instances details

FromJSON CaptchaAction Source #
Instance details Defined in Amazonka.WAFV2.Types.CaptchaAction Methods parseJSON :: Value -> Parser CaptchaAction # parseJSONList :: Value -> Parser [CaptchaAction] #
ToJSON CaptchaAction Source #
Instance details Defined in Amazonka.WAFV2.Types.CaptchaAction Methods toJSON :: CaptchaAction -> Value # toEncoding :: CaptchaAction -> Encoding # toJSONList :: [CaptchaAction] -> Value # toEncodingList :: [CaptchaAction] -> Encoding #
Generic CaptchaAction Source #
Instance details Defined in Amazonka.WAFV2.Types.CaptchaAction Associated Types type Rep CaptchaAction :: Type -> Type # Methods from :: CaptchaAction -> Rep CaptchaAction x # to :: Rep CaptchaAction x -> CaptchaAction #
Read CaptchaAction Source #
Instance details Defined in Amazonka.WAFV2.Types.CaptchaAction Methods readsPrec :: Int -> ReadS CaptchaAction # readList :: ReadS [CaptchaAction] # readPrec :: ReadPrec CaptchaAction # readListPrec :: ReadPrec [CaptchaAction] #
Show CaptchaAction Source #
Instance details Defined in Amazonka.WAFV2.Types.CaptchaAction Methods showsPrec :: Int -> CaptchaAction -> ShowS # show :: CaptchaAction -> String # showList :: [CaptchaAction] -> ShowS #
NFData CaptchaAction Source #
Instance details Defined in Amazonka.WAFV2.Types.CaptchaAction Methods rnf :: CaptchaAction -> () #
Eq CaptchaAction Source #
Instance details Defined in Amazonka.WAFV2.Types.CaptchaAction Methods (==) :: CaptchaAction -> CaptchaAction -> Bool # (/=) :: CaptchaAction -> CaptchaAction -> Bool #
Hashable CaptchaAction Source #
Instance details Defined in Amazonka.WAFV2.Types.CaptchaAction Methods hashWithSalt :: Int -> CaptchaAction -> Int # hash :: CaptchaAction -> Int #
type Rep CaptchaAction Source #
Instance details Defined in Amazonka.WAFV2.Types.CaptchaAction type Rep CaptchaAction = D1 ('MetaData "CaptchaAction" "Amazonka.WAFV2.Types.CaptchaAction" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "CaptchaAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customRequestHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomRequestHandling))))

newCaptchaAction :: CaptchaAction Source #

Create a value of CaptchaAction 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:CaptchaAction', captchaAction_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.

captchaAction_customRequestHandling :: Lens' CaptchaAction (Maybe CustomRequestHandling) Source #

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.