This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-wafv2/include/aws/wafv2/model/ManagedRuleGroupStatement.h

221 lines
8.8 KiB
C++

/**
* 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/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/wafv2/model/ExcludedRule.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace WAFV2
{
namespace Model
{
/**
* <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2,
* released in November, 2019. For information, including how to migrate your AWS
* WAF resources from the prior release, see the <a
* href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS
* WAF Developer Guide</a>. </p> <p>A rule statement used to run the rules
* that are defined in a managed rule group. To use this, provide the vendor name
* and the name of the rule group in this statement. You can retrieve the required
* names by calling <a>ListAvailableManagedRuleGroups</a>.</p> <p>You can't nest a
* <code>ManagedRuleGroupStatement</code>, for example for use inside a
* <code>NotStatement</code> or <code>OrStatement</code>. It can only be referenced
* as a top-level statement within a rule.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/ManagedRuleGroupStatement">AWS
* API Reference</a></p>
*/
class AWS_WAFV2_API ManagedRuleGroupStatement
{
public:
ManagedRuleGroupStatement();
ManagedRuleGroupStatement(Aws::Utils::Json::JsonView jsonValue);
ManagedRuleGroupStatement& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The name of the managed rule group vendor. You use this, along with the rule
* group name, to identify the rule group.</p>
*/
inline const Aws::String& GetVendorName() const{ return m_vendorName; }
/**
* <p>The name of the managed rule group vendor. You use this, along with the rule
* group name, to identify the rule group.</p>
*/
inline bool VendorNameHasBeenSet() const { return m_vendorNameHasBeenSet; }
/**
* <p>The name of the managed rule group vendor. You use this, along with the rule
* group name, to identify the rule group.</p>
*/
inline void SetVendorName(const Aws::String& value) { m_vendorNameHasBeenSet = true; m_vendorName = value; }
/**
* <p>The name of the managed rule group vendor. You use this, along with the rule
* group name, to identify the rule group.</p>
*/
inline void SetVendorName(Aws::String&& value) { m_vendorNameHasBeenSet = true; m_vendorName = std::move(value); }
/**
* <p>The name of the managed rule group vendor. You use this, along with the rule
* group name, to identify the rule group.</p>
*/
inline void SetVendorName(const char* value) { m_vendorNameHasBeenSet = true; m_vendorName.assign(value); }
/**
* <p>The name of the managed rule group vendor. You use this, along with the rule
* group name, to identify the rule group.</p>
*/
inline ManagedRuleGroupStatement& WithVendorName(const Aws::String& value) { SetVendorName(value); return *this;}
/**
* <p>The name of the managed rule group vendor. You use this, along with the rule
* group name, to identify the rule group.</p>
*/
inline ManagedRuleGroupStatement& WithVendorName(Aws::String&& value) { SetVendorName(std::move(value)); return *this;}
/**
* <p>The name of the managed rule group vendor. You use this, along with the rule
* group name, to identify the rule group.</p>
*/
inline ManagedRuleGroupStatement& WithVendorName(const char* value) { SetVendorName(value); return *this;}
/**
* <p>The name of the managed rule group. You use this, along with the vendor name,
* to identify the rule group.</p>
*/
inline const Aws::String& GetName() const{ return m_name; }
/**
* <p>The name of the managed rule group. You use this, along with the vendor name,
* to identify the rule group.</p>
*/
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
/**
* <p>The name of the managed rule group. You use this, along with the vendor name,
* to identify the rule group.</p>
*/
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
/**
* <p>The name of the managed rule group. You use this, along with the vendor name,
* to identify the rule group.</p>
*/
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
/**
* <p>The name of the managed rule group. You use this, along with the vendor name,
* to identify the rule group.</p>
*/
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
/**
* <p>The name of the managed rule group. You use this, along with the vendor name,
* to identify the rule group.</p>
*/
inline ManagedRuleGroupStatement& WithName(const Aws::String& value) { SetName(value); return *this;}
/**
* <p>The name of the managed rule group. You use this, along with the vendor name,
* to identify the rule group.</p>
*/
inline ManagedRuleGroupStatement& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
/**
* <p>The name of the managed rule group. You use this, along with the vendor name,
* to identify the rule group.</p>
*/
inline ManagedRuleGroupStatement& WithName(const char* value) { SetName(value); return *this;}
/**
* <p>The rules whose actions are set to <code>COUNT</code> by the web ACL,
* regardless of the action that is set on the rule. This effectively excludes the
* rule from acting on web requests. </p>
*/
inline const Aws::Vector<ExcludedRule>& GetExcludedRules() const{ return m_excludedRules; }
/**
* <p>The rules whose actions are set to <code>COUNT</code> by the web ACL,
* regardless of the action that is set on the rule. This effectively excludes the
* rule from acting on web requests. </p>
*/
inline bool ExcludedRulesHasBeenSet() const { return m_excludedRulesHasBeenSet; }
/**
* <p>The rules whose actions are set to <code>COUNT</code> by the web ACL,
* regardless of the action that is set on the rule. This effectively excludes the
* rule from acting on web requests. </p>
*/
inline void SetExcludedRules(const Aws::Vector<ExcludedRule>& value) { m_excludedRulesHasBeenSet = true; m_excludedRules = value; }
/**
* <p>The rules whose actions are set to <code>COUNT</code> by the web ACL,
* regardless of the action that is set on the rule. This effectively excludes the
* rule from acting on web requests. </p>
*/
inline void SetExcludedRules(Aws::Vector<ExcludedRule>&& value) { m_excludedRulesHasBeenSet = true; m_excludedRules = std::move(value); }
/**
* <p>The rules whose actions are set to <code>COUNT</code> by the web ACL,
* regardless of the action that is set on the rule. This effectively excludes the
* rule from acting on web requests. </p>
*/
inline ManagedRuleGroupStatement& WithExcludedRules(const Aws::Vector<ExcludedRule>& value) { SetExcludedRules(value); return *this;}
/**
* <p>The rules whose actions are set to <code>COUNT</code> by the web ACL,
* regardless of the action that is set on the rule. This effectively excludes the
* rule from acting on web requests. </p>
*/
inline ManagedRuleGroupStatement& WithExcludedRules(Aws::Vector<ExcludedRule>&& value) { SetExcludedRules(std::move(value)); return *this;}
/**
* <p>The rules whose actions are set to <code>COUNT</code> by the web ACL,
* regardless of the action that is set on the rule. This effectively excludes the
* rule from acting on web requests. </p>
*/
inline ManagedRuleGroupStatement& AddExcludedRules(const ExcludedRule& value) { m_excludedRulesHasBeenSet = true; m_excludedRules.push_back(value); return *this; }
/**
* <p>The rules whose actions are set to <code>COUNT</code> by the web ACL,
* regardless of the action that is set on the rule. This effectively excludes the
* rule from acting on web requests. </p>
*/
inline ManagedRuleGroupStatement& AddExcludedRules(ExcludedRule&& value) { m_excludedRulesHasBeenSet = true; m_excludedRules.push_back(std::move(value)); return *this; }
private:
Aws::String m_vendorName;
bool m_vendorNameHasBeenSet;
Aws::String m_name;
bool m_nameHasBeenSet;
Aws::Vector<ExcludedRule> m_excludedRules;
bool m_excludedRulesHasBeenSet;
};
} // namespace Model
} // namespace WAFV2
} // namespace Aws