/**
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0.
 */

#pragma once
#include <aws/wafv2/WAFV2_EXPORTS.h>
#include <aws/wafv2/model/CustomRequestHandling.h>
#include <utility>

namespace Aws
{
namespace Utils
{
namespace Json
{
  class JsonValue;
  class JsonView;
} // namespace Json
} // namespace Utils
namespace WAFV2
{
namespace Model
{

  /**
   * <p>Specifies that WAF should run a <code>CAPTCHA</code> check against the
   * request: </p> <ul> <li> <p>If the request includes a valid, unexpired
   * <code>CAPTCHA</code> 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 <code>CountAction</code>. </p> </li> <li> <p>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.</p> <p>WAF generates a response that it sends back to the client,
   * which includes the following: </p> <ul> <li> <p>The header
   * <code>x-amzn-waf-action</code> with a value of <code>captcha</code>. </p> </li>
   * <li> <p>The HTTP status code <code>405 Method Not Allowed</code>. </p> </li>
   * <li> <p>If the request contains an <code>Accept</code> header with a value of
   * <code>text/html</code>, the response includes a <code>CAPTCHA</code> JavaScript
   * page interstitial. </p> </li> </ul> </li> </ul> <p>You can configure the
   * expiration time in the <code>CaptchaConfig</code>
   * <code>ImmunityTimeProperty</code> setting at the rule and web ACL level. The
   * rule setting overrides the web ACL setting. </p> <p>This action option is
   * available for rules. It isn't available for web ACL default actions.
   * </p><p><h3>See Also:</h3>   <a
   * href="http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CaptchaAction">AWS
   * API Reference</a></p>
   */
  class CaptchaAction
  {
  public:
    AWS_WAFV2_API CaptchaAction();
    AWS_WAFV2_API CaptchaAction(Aws::Utils::Json::JsonView jsonValue);
    AWS_WAFV2_API CaptchaAction& operator=(Aws::Utils::Json::JsonView jsonValue);
    AWS_WAFV2_API Aws::Utils::Json::JsonValue Jsonize() const;


    /**
     * <p>Defines custom handling for the web request, used when the
     * <code>CAPTCHA</code> inspection determines that the request's token is valid and
     * unexpired.</p> <p>For information about customizing web requests and responses,
     * see <a
     * href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing
     * web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>. </p>
     */
    inline const CustomRequestHandling& GetCustomRequestHandling() const{ return m_customRequestHandling; }

    /**
     * <p>Defines custom handling for the web request, used when the
     * <code>CAPTCHA</code> inspection determines that the request's token is valid and
     * unexpired.</p> <p>For information about customizing web requests and responses,
     * see <a
     * href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing
     * web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>. </p>
     */
    inline bool CustomRequestHandlingHasBeenSet() const { return m_customRequestHandlingHasBeenSet; }

    /**
     * <p>Defines custom handling for the web request, used when the
     * <code>CAPTCHA</code> inspection determines that the request's token is valid and
     * unexpired.</p> <p>For information about customizing web requests and responses,
     * see <a
     * href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing
     * web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>. </p>
     */
    inline void SetCustomRequestHandling(const CustomRequestHandling& value) { m_customRequestHandlingHasBeenSet = true; m_customRequestHandling = value; }

    /**
     * <p>Defines custom handling for the web request, used when the
     * <code>CAPTCHA</code> inspection determines that the request's token is valid and
     * unexpired.</p> <p>For information about customizing web requests and responses,
     * see <a
     * href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing
     * web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>. </p>
     */
    inline void SetCustomRequestHandling(CustomRequestHandling&& value) { m_customRequestHandlingHasBeenSet = true; m_customRequestHandling = std::move(value); }

    /**
     * <p>Defines custom handling for the web request, used when the
     * <code>CAPTCHA</code> inspection determines that the request's token is valid and
     * unexpired.</p> <p>For information about customizing web requests and responses,
     * see <a
     * href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing
     * web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>. </p>
     */
    inline CaptchaAction& WithCustomRequestHandling(const CustomRequestHandling& value) { SetCustomRequestHandling(value); return *this;}

    /**
     * <p>Defines custom handling for the web request, used when the
     * <code>CAPTCHA</code> inspection determines that the request's token is valid and
     * unexpired.</p> <p>For information about customizing web requests and responses,
     * see <a
     * href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing
     * web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>. </p>
     */
    inline CaptchaAction& WithCustomRequestHandling(CustomRequestHandling&& value) { SetCustomRequestHandling(std::move(value)); return *this;}

  private:

    CustomRequestHandling m_customRequestHandling;
    bool m_customRequestHandlingHasBeenSet = false;
  };

} // namespace Model
} // namespace WAFV2
} // namespace Aws