pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-securityhub/include/aws/securityhub/model/AwsWafWebAclRule.h

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

#pragma once
#include <aws/securityhub/SecurityHub_EXPORTS.h>
#include <aws/securityhub/model/WafAction.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/securityhub/model/WafOverrideAction.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/securityhub/model/WafExcludedRule.h>
#include <utility>

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

  /**
   * <p>Details for a rule in a WAF WebACL.</p><p><h3>See Also:</h3>   <a
   * href="http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AwsWafWebAclRule">AWS
   * API Reference</a></p>
   */
  class AWS_SECURITYHUB_API AwsWafWebAclRule
  {
  public:
    AwsWafWebAclRule();
    AwsWafWebAclRule(Aws::Utils::Json::JsonView jsonValue);
    AwsWafWebAclRule& operator=(Aws::Utils::Json::JsonView jsonValue);
    Aws::Utils::Json::JsonValue Jsonize() const;


    /**
     * <p>Specifies the action that CloudFront or AWS WAF takes when a web request
     * matches the conditions in the rule. </p>
     */
    inline const WafAction& GetAction() const{ return m_action; }

    /**
     * <p>Specifies the action that CloudFront or AWS WAF takes when a web request
     * matches the conditions in the rule. </p>
     */
    inline bool ActionHasBeenSet() const { return m_actionHasBeenSet; }

    /**
     * <p>Specifies the action that CloudFront or AWS WAF takes when a web request
     * matches the conditions in the rule. </p>
     */
    inline void SetAction(const WafAction& value) { m_actionHasBeenSet = true; m_action = value; }

    /**
     * <p>Specifies the action that CloudFront or AWS WAF takes when a web request
     * matches the conditions in the rule. </p>
     */
    inline void SetAction(WafAction&& value) { m_actionHasBeenSet = true; m_action = std::move(value); }

    /**
     * <p>Specifies the action that CloudFront or AWS WAF takes when a web request
     * matches the conditions in the rule. </p>
     */
    inline AwsWafWebAclRule& WithAction(const WafAction& value) { SetAction(value); return *this;}

    /**
     * <p>Specifies the action that CloudFront or AWS WAF takes when a web request
     * matches the conditions in the rule. </p>
     */
    inline AwsWafWebAclRule& WithAction(WafAction&& value) { SetAction(std::move(value)); return *this;}


    /**
     * <p>Rules to exclude from a rule group.</p>
     */
    inline const Aws::Vector<WafExcludedRule>& GetExcludedRules() const{ return m_excludedRules; }

    /**
     * <p>Rules to exclude from a rule group.</p>
     */
    inline bool ExcludedRulesHasBeenSet() const { return m_excludedRulesHasBeenSet; }

    /**
     * <p>Rules to exclude from a rule group.</p>
     */
    inline void SetExcludedRules(const Aws::Vector<WafExcludedRule>& value) { m_excludedRulesHasBeenSet = true; m_excludedRules = value; }

    /**
     * <p>Rules to exclude from a rule group.</p>
     */
    inline void SetExcludedRules(Aws::Vector<WafExcludedRule>&& value) { m_excludedRulesHasBeenSet = true; m_excludedRules = std::move(value); }

    /**
     * <p>Rules to exclude from a rule group.</p>
     */
    inline AwsWafWebAclRule& WithExcludedRules(const Aws::Vector<WafExcludedRule>& value) { SetExcludedRules(value); return *this;}

    /**
     * <p>Rules to exclude from a rule group.</p>
     */
    inline AwsWafWebAclRule& WithExcludedRules(Aws::Vector<WafExcludedRule>&& value) { SetExcludedRules(std::move(value)); return *this;}

    /**
     * <p>Rules to exclude from a rule group.</p>
     */
    inline AwsWafWebAclRule& AddExcludedRules(const WafExcludedRule& value) { m_excludedRulesHasBeenSet = true; m_excludedRules.push_back(value); return *this; }

    /**
     * <p>Rules to exclude from a rule group.</p>
     */
    inline AwsWafWebAclRule& AddExcludedRules(WafExcludedRule&& value) { m_excludedRulesHasBeenSet = true; m_excludedRules.push_back(std::move(value)); return *this; }


    /**
     * <p>Use the <code>OverrideAction</code> to test your RuleGroup.</p> <p>Any rule
     * in a RuleGroup can potentially block a request. If you set the
     * <code>OverrideAction</code> to <code>None</code>, the RuleGroup blocks a request
     * if any individual rule in the RuleGroup matches the request and is configured to
     * block that request.</p> <p>However, if you first want to test the RuleGroup, set
     * the <code>OverrideAction</code> to <code>Count</code>. The RuleGroup then
     * overrides any block action specified by individual rules contained within the
     * group. Instead of blocking matching requests, those requests are counted.</p>
     * <p> <code>ActivatedRule</code>|<code>OverrideAction</code> applies only when
     * updating or adding a RuleGroup to a WebACL. In this case you do not use
     * <code>ActivatedRule</code>|<code>Action</code>. For all other update requests,
     * <code>ActivatedRule</code>|<code>Action</code> is used instead of
     * <code>ActivatedRule</code>|<code>OverrideAction</code>. </p>
     */
    inline const WafOverrideAction& GetOverrideAction() const{ return m_overrideAction; }

    /**
     * <p>Use the <code>OverrideAction</code> to test your RuleGroup.</p> <p>Any rule
     * in a RuleGroup can potentially block a request. If you set the
     * <code>OverrideAction</code> to <code>None</code>, the RuleGroup blocks a request
     * if any individual rule in the RuleGroup matches the request and is configured to
     * block that request.</p> <p>However, if you first want to test the RuleGroup, set
     * the <code>OverrideAction</code> to <code>Count</code>. The RuleGroup then
     * overrides any block action specified by individual rules contained within the
     * group. Instead of blocking matching requests, those requests are counted.</p>
     * <p> <code>ActivatedRule</code>|<code>OverrideAction</code> applies only when
     * updating or adding a RuleGroup to a WebACL. In this case you do not use
     * <code>ActivatedRule</code>|<code>Action</code>. For all other update requests,
     * <code>ActivatedRule</code>|<code>Action</code> is used instead of
     * <code>ActivatedRule</code>|<code>OverrideAction</code>. </p>
     */
    inline bool OverrideActionHasBeenSet() const { return m_overrideActionHasBeenSet; }

    /**
     * <p>Use the <code>OverrideAction</code> to test your RuleGroup.</p> <p>Any rule
     * in a RuleGroup can potentially block a request. If you set the
     * <code>OverrideAction</code> to <code>None</code>, the RuleGroup blocks a request
     * if any individual rule in the RuleGroup matches the request and is configured to
     * block that request.</p> <p>However, if you first want to test the RuleGroup, set
     * the <code>OverrideAction</code> to <code>Count</code>. The RuleGroup then
     * overrides any block action specified by individual rules contained within the
     * group. Instead of blocking matching requests, those requests are counted.</p>
     * <p> <code>ActivatedRule</code>|<code>OverrideAction</code> applies only when
     * updating or adding a RuleGroup to a WebACL. In this case you do not use
     * <code>ActivatedRule</code>|<code>Action</code>. For all other update requests,
     * <code>ActivatedRule</code>|<code>Action</code> is used instead of
     * <code>ActivatedRule</code>|<code>OverrideAction</code>. </p>
     */
    inline void SetOverrideAction(const WafOverrideAction& value) { m_overrideActionHasBeenSet = true; m_overrideAction = value; }

    /**
     * <p>Use the <code>OverrideAction</code> to test your RuleGroup.</p> <p>Any rule
     * in a RuleGroup can potentially block a request. If you set the
     * <code>OverrideAction</code> to <code>None</code>, the RuleGroup blocks a request
     * if any individual rule in the RuleGroup matches the request and is configured to
     * block that request.</p> <p>However, if you first want to test the RuleGroup, set
     * the <code>OverrideAction</code> to <code>Count</code>. The RuleGroup then
     * overrides any block action specified by individual rules contained within the
     * group. Instead of blocking matching requests, those requests are counted.</p>
     * <p> <code>ActivatedRule</code>|<code>OverrideAction</code> applies only when
     * updating or adding a RuleGroup to a WebACL. In this case you do not use
     * <code>ActivatedRule</code>|<code>Action</code>. For all other update requests,
     * <code>ActivatedRule</code>|<code>Action</code> is used instead of
     * <code>ActivatedRule</code>|<code>OverrideAction</code>. </p>
     */
    inline void SetOverrideAction(WafOverrideAction&& value) { m_overrideActionHasBeenSet = true; m_overrideAction = std::move(value); }

    /**
     * <p>Use the <code>OverrideAction</code> to test your RuleGroup.</p> <p>Any rule
     * in a RuleGroup can potentially block a request. If you set the
     * <code>OverrideAction</code> to <code>None</code>, the RuleGroup blocks a request
     * if any individual rule in the RuleGroup matches the request and is configured to
     * block that request.</p> <p>However, if you first want to test the RuleGroup, set
     * the <code>OverrideAction</code> to <code>Count</code>. The RuleGroup then
     * overrides any block action specified by individual rules contained within the
     * group. Instead of blocking matching requests, those requests are counted.</p>
     * <p> <code>ActivatedRule</code>|<code>OverrideAction</code> applies only when
     * updating or adding a RuleGroup to a WebACL. In this case you do not use
     * <code>ActivatedRule</code>|<code>Action</code>. For all other update requests,
     * <code>ActivatedRule</code>|<code>Action</code> is used instead of
     * <code>ActivatedRule</code>|<code>OverrideAction</code>. </p>
     */
    inline AwsWafWebAclRule& WithOverrideAction(const WafOverrideAction& value) { SetOverrideAction(value); return *this;}

    /**
     * <p>Use the <code>OverrideAction</code> to test your RuleGroup.</p> <p>Any rule
     * in a RuleGroup can potentially block a request. If you set the
     * <code>OverrideAction</code> to <code>None</code>, the RuleGroup blocks a request
     * if any individual rule in the RuleGroup matches the request and is configured to
     * block that request.</p> <p>However, if you first want to test the RuleGroup, set
     * the <code>OverrideAction</code> to <code>Count</code>. The RuleGroup then
     * overrides any block action specified by individual rules contained within the
     * group. Instead of blocking matching requests, those requests are counted.</p>
     * <p> <code>ActivatedRule</code>|<code>OverrideAction</code> applies only when
     * updating or adding a RuleGroup to a WebACL. In this case you do not use
     * <code>ActivatedRule</code>|<code>Action</code>. For all other update requests,
     * <code>ActivatedRule</code>|<code>Action</code> is used instead of
     * <code>ActivatedRule</code>|<code>OverrideAction</code>. </p>
     */
    inline AwsWafWebAclRule& WithOverrideAction(WafOverrideAction&& value) { SetOverrideAction(std::move(value)); return *this;}


    /**
     * <p>Specifies the order in which the rules in a WebACL are evaluated. Rules with
     * a lower value for <code>Priority</code> are evaluated before rules with a higher
     * value. The value must be a unique integer. If you add multiple rules to a
     * WebACL, the values do not need to be consecutive.</p>
     */
    inline int GetPriority() const{ return m_priority; }

    /**
     * <p>Specifies the order in which the rules in a WebACL are evaluated. Rules with
     * a lower value for <code>Priority</code> are evaluated before rules with a higher
     * value. The value must be a unique integer. If you add multiple rules to a
     * WebACL, the values do not need to be consecutive.</p>
     */
    inline bool PriorityHasBeenSet() const { return m_priorityHasBeenSet; }

    /**
     * <p>Specifies the order in which the rules in a WebACL are evaluated. Rules with
     * a lower value for <code>Priority</code> are evaluated before rules with a higher
     * value. The value must be a unique integer. If you add multiple rules to a
     * WebACL, the values do not need to be consecutive.</p>
     */
    inline void SetPriority(int value) { m_priorityHasBeenSet = true; m_priority = value; }

    /**
     * <p>Specifies the order in which the rules in a WebACL are evaluated. Rules with
     * a lower value for <code>Priority</code> are evaluated before rules with a higher
     * value. The value must be a unique integer. If you add multiple rules to a
     * WebACL, the values do not need to be consecutive.</p>
     */
    inline AwsWafWebAclRule& WithPriority(int value) { SetPriority(value); return *this;}


    /**
     * <p>The identifier for a rule.</p>
     */
    inline const Aws::String& GetRuleId() const{ return m_ruleId; }

    /**
     * <p>The identifier for a rule.</p>
     */
    inline bool RuleIdHasBeenSet() const { return m_ruleIdHasBeenSet; }

    /**
     * <p>The identifier for a rule.</p>
     */
    inline void SetRuleId(const Aws::String& value) { m_ruleIdHasBeenSet = true; m_ruleId = value; }

    /**
     * <p>The identifier for a rule.</p>
     */
    inline void SetRuleId(Aws::String&& value) { m_ruleIdHasBeenSet = true; m_ruleId = std::move(value); }

    /**
     * <p>The identifier for a rule.</p>
     */
    inline void SetRuleId(const char* value) { m_ruleIdHasBeenSet = true; m_ruleId.assign(value); }

    /**
     * <p>The identifier for a rule.</p>
     */
    inline AwsWafWebAclRule& WithRuleId(const Aws::String& value) { SetRuleId(value); return *this;}

    /**
     * <p>The identifier for a rule.</p>
     */
    inline AwsWafWebAclRule& WithRuleId(Aws::String&& value) { SetRuleId(std::move(value)); return *this;}

    /**
     * <p>The identifier for a rule.</p>
     */
    inline AwsWafWebAclRule& WithRuleId(const char* value) { SetRuleId(value); return *this;}


    /**
     * <p>The rule type.</p> <p>Valid values: <code>REGULAR</code> |
     * <code>RATE_BASED</code> | <code>GROUP</code> </p> <p>The default is
     * <code>REGULAR</code>.</p>
     */
    inline const Aws::String& GetType() const{ return m_type; }

    /**
     * <p>The rule type.</p> <p>Valid values: <code>REGULAR</code> |
     * <code>RATE_BASED</code> | <code>GROUP</code> </p> <p>The default is
     * <code>REGULAR</code>.</p>
     */
    inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; }

    /**
     * <p>The rule type.</p> <p>Valid values: <code>REGULAR</code> |
     * <code>RATE_BASED</code> | <code>GROUP</code> </p> <p>The default is
     * <code>REGULAR</code>.</p>
     */
    inline void SetType(const Aws::String& value) { m_typeHasBeenSet = true; m_type = value; }

    /**
     * <p>The rule type.</p> <p>Valid values: <code>REGULAR</code> |
     * <code>RATE_BASED</code> | <code>GROUP</code> </p> <p>The default is
     * <code>REGULAR</code>.</p>
     */
    inline void SetType(Aws::String&& value) { m_typeHasBeenSet = true; m_type = std::move(value); }

    /**
     * <p>The rule type.</p> <p>Valid values: <code>REGULAR</code> |
     * <code>RATE_BASED</code> | <code>GROUP</code> </p> <p>The default is
     * <code>REGULAR</code>.</p>
     */
    inline void SetType(const char* value) { m_typeHasBeenSet = true; m_type.assign(value); }

    /**
     * <p>The rule type.</p> <p>Valid values: <code>REGULAR</code> |
     * <code>RATE_BASED</code> | <code>GROUP</code> </p> <p>The default is
     * <code>REGULAR</code>.</p>
     */
    inline AwsWafWebAclRule& WithType(const Aws::String& value) { SetType(value); return *this;}

    /**
     * <p>The rule type.</p> <p>Valid values: <code>REGULAR</code> |
     * <code>RATE_BASED</code> | <code>GROUP</code> </p> <p>The default is
     * <code>REGULAR</code>.</p>
     */
    inline AwsWafWebAclRule& WithType(Aws::String&& value) { SetType(std::move(value)); return *this;}

    /**
     * <p>The rule type.</p> <p>Valid values: <code>REGULAR</code> |
     * <code>RATE_BASED</code> | <code>GROUP</code> </p> <p>The default is
     * <code>REGULAR</code>.</p>
     */
    inline AwsWafWebAclRule& WithType(const char* value) { SetType(value); return *this;}

  private:

    WafAction m_action;
    bool m_actionHasBeenSet;

    Aws::Vector<WafExcludedRule> m_excludedRules;
    bool m_excludedRulesHasBeenSet;

    WafOverrideAction m_overrideAction;
    bool m_overrideActionHasBeenSet;

    int m_priority;
    bool m_priorityHasBeenSet;

    Aws::String m_ruleId;
    bool m_ruleIdHasBeenSet;

    Aws::String m_type;
    bool m_typeHasBeenSet;
  };

} // namespace Model
} // namespace SecurityHub
} // namespace Aws