/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace WAFV2 { namespace Model { class DescribeManagedRuleGroupResult { public: AWS_WAFV2_API DescribeManagedRuleGroupResult(); AWS_WAFV2_API DescribeManagedRuleGroupResult(const Aws::AmazonWebServiceResult& result); AWS_WAFV2_API DescribeManagedRuleGroupResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The managed rule group's version.

*/ inline const Aws::String& GetVersionName() const{ return m_versionName; } /** *

The managed rule group's version.

*/ inline void SetVersionName(const Aws::String& value) { m_versionName = value; } /** *

The managed rule group's version.

*/ inline void SetVersionName(Aws::String&& value) { m_versionName = std::move(value); } /** *

The managed rule group's version.

*/ inline void SetVersionName(const char* value) { m_versionName.assign(value); } /** *

The managed rule group's version.

*/ inline DescribeManagedRuleGroupResult& WithVersionName(const Aws::String& value) { SetVersionName(value); return *this;} /** *

The managed rule group's version.

*/ inline DescribeManagedRuleGroupResult& WithVersionName(Aws::String&& value) { SetVersionName(std::move(value)); return *this;} /** *

The managed rule group's version.

*/ inline DescribeManagedRuleGroupResult& WithVersionName(const char* value) { SetVersionName(value); return *this;} /** *

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS * topic that's used to provide notification of changes to the managed rule group. * You can subscribe to the SNS topic to receive notifications when the managed * rule group is modified, such as for new versions and for version expiration. For * more information, see the Amazon Simple * Notification Service Developer Guide.

*/ inline const Aws::String& GetSnsTopicArn() const{ return m_snsTopicArn; } /** *

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS * topic that's used to provide notification of changes to the managed rule group. * You can subscribe to the SNS topic to receive notifications when the managed * rule group is modified, such as for new versions and for version expiration. For * more information, see the Amazon Simple * Notification Service Developer Guide.

*/ inline void SetSnsTopicArn(const Aws::String& value) { m_snsTopicArn = value; } /** *

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS * topic that's used to provide notification of changes to the managed rule group. * You can subscribe to the SNS topic to receive notifications when the managed * rule group is modified, such as for new versions and for version expiration. For * more information, see the Amazon Simple * Notification Service Developer Guide.

*/ inline void SetSnsTopicArn(Aws::String&& value) { m_snsTopicArn = std::move(value); } /** *

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS * topic that's used to provide notification of changes to the managed rule group. * You can subscribe to the SNS topic to receive notifications when the managed * rule group is modified, such as for new versions and for version expiration. For * more information, see the Amazon Simple * Notification Service Developer Guide.

*/ inline void SetSnsTopicArn(const char* value) { m_snsTopicArn.assign(value); } /** *

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS * topic that's used to provide notification of changes to the managed rule group. * You can subscribe to the SNS topic to receive notifications when the managed * rule group is modified, such as for new versions and for version expiration. For * more information, see the Amazon Simple * Notification Service Developer Guide.

*/ inline DescribeManagedRuleGroupResult& WithSnsTopicArn(const Aws::String& value) { SetSnsTopicArn(value); return *this;} /** *

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS * topic that's used to provide notification of changes to the managed rule group. * You can subscribe to the SNS topic to receive notifications when the managed * rule group is modified, such as for new versions and for version expiration. For * more information, see the Amazon Simple * Notification Service Developer Guide.

*/ inline DescribeManagedRuleGroupResult& WithSnsTopicArn(Aws::String&& value) { SetSnsTopicArn(std::move(value)); return *this;} /** *

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS * topic that's used to provide notification of changes to the managed rule group. * You can subscribe to the SNS topic to receive notifications when the managed * rule group is modified, such as for new versions and for version expiration. For * more information, see the Amazon Simple * Notification Service Developer Guide.

*/ inline DescribeManagedRuleGroupResult& WithSnsTopicArn(const char* value) { SetSnsTopicArn(value); return *this;} /** *

The web ACL capacity units (WCUs) required for this rule group.

WAF * uses WCUs to calculate and control the operating resources that are used to run * your rules, rule groups, and web ACLs. WAF calculates capacity differently for * each rule type, to reflect the relative cost of each rule. Simple rules that * cost little to run use fewer WCUs than more complex rules that use more * processing power. Rule group capacity is fixed at creation, which helps users * plan their web ACL WCU usage when they use a rule group. For more information, * see WAF * web ACL capacity units (WCU) in the WAF Developer Guide.

*/ inline long long GetCapacity() const{ return m_capacity; } /** *

The web ACL capacity units (WCUs) required for this rule group.

WAF * uses WCUs to calculate and control the operating resources that are used to run * your rules, rule groups, and web ACLs. WAF calculates capacity differently for * each rule type, to reflect the relative cost of each rule. Simple rules that * cost little to run use fewer WCUs than more complex rules that use more * processing power. Rule group capacity is fixed at creation, which helps users * plan their web ACL WCU usage when they use a rule group. For more information, * see WAF * web ACL capacity units (WCU) in the WAF Developer Guide.

*/ inline void SetCapacity(long long value) { m_capacity = value; } /** *

The web ACL capacity units (WCUs) required for this rule group.

WAF * uses WCUs to calculate and control the operating resources that are used to run * your rules, rule groups, and web ACLs. WAF calculates capacity differently for * each rule type, to reflect the relative cost of each rule. Simple rules that * cost little to run use fewer WCUs than more complex rules that use more * processing power. Rule group capacity is fixed at creation, which helps users * plan their web ACL WCU usage when they use a rule group. For more information, * see WAF * web ACL capacity units (WCU) in the WAF Developer Guide.

*/ inline DescribeManagedRuleGroupResult& WithCapacity(long long value) { SetCapacity(value); return *this;} /** *

*/ inline const Aws::Vector& GetRules() const{ return m_rules; } /** *

*/ inline void SetRules(const Aws::Vector& value) { m_rules = value; } /** *

*/ inline void SetRules(Aws::Vector&& value) { m_rules = std::move(value); } /** *

*/ inline DescribeManagedRuleGroupResult& WithRules(const Aws::Vector& value) { SetRules(value); return *this;} /** *

*/ inline DescribeManagedRuleGroupResult& WithRules(Aws::Vector&& value) { SetRules(std::move(value)); return *this;} /** *

*/ inline DescribeManagedRuleGroupResult& AddRules(const RuleSummary& value) { m_rules.push_back(value); return *this; } /** *

*/ inline DescribeManagedRuleGroupResult& AddRules(RuleSummary&& value) { m_rules.push_back(std::move(value)); return *this; } /** *

The label namespace prefix for this rule group. All labels added by rules in * this rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

  • *
  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline const Aws::String& GetLabelNamespace() const{ return m_labelNamespace; } /** *

The label namespace prefix for this rule group. All labels added by rules in * this rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

  • *
  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline void SetLabelNamespace(const Aws::String& value) { m_labelNamespace = value; } /** *

The label namespace prefix for this rule group. All labels added by rules in * this rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

  • *
  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline void SetLabelNamespace(Aws::String&& value) { m_labelNamespace = std::move(value); } /** *

The label namespace prefix for this rule group. All labels added by rules in * this rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

  • *
  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline void SetLabelNamespace(const char* value) { m_labelNamespace.assign(value); } /** *

The label namespace prefix for this rule group. All labels added by rules in * this rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

  • *
  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline DescribeManagedRuleGroupResult& WithLabelNamespace(const Aws::String& value) { SetLabelNamespace(value); return *this;} /** *

The label namespace prefix for this rule group. All labels added by rules in * this rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

  • *
  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline DescribeManagedRuleGroupResult& WithLabelNamespace(Aws::String&& value) { SetLabelNamespace(std::move(value)); return *this;} /** *

The label namespace prefix for this rule group. All labels added by rules in * this rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

  • *
  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline DescribeManagedRuleGroupResult& WithLabelNamespace(const char* value) { SetLabelNamespace(value); return *this;} /** *

The labels that one or more rules in this rule group add to matching web * requests. These labels are defined in the RuleLabels for a * Rule.

*/ inline const Aws::Vector& GetAvailableLabels() const{ return m_availableLabels; } /** *

The labels that one or more rules in this rule group add to matching web * requests. These labels are defined in the RuleLabels for a * Rule.

*/ inline void SetAvailableLabels(const Aws::Vector& value) { m_availableLabels = value; } /** *

The labels that one or more rules in this rule group add to matching web * requests. These labels are defined in the RuleLabels for a * Rule.

*/ inline void SetAvailableLabels(Aws::Vector&& value) { m_availableLabels = std::move(value); } /** *

The labels that one or more rules in this rule group add to matching web * requests. These labels are defined in the RuleLabels for a * Rule.

*/ inline DescribeManagedRuleGroupResult& WithAvailableLabels(const Aws::Vector& value) { SetAvailableLabels(value); return *this;} /** *

The labels that one or more rules in this rule group add to matching web * requests. These labels are defined in the RuleLabels for a * Rule.

*/ inline DescribeManagedRuleGroupResult& WithAvailableLabels(Aws::Vector&& value) { SetAvailableLabels(std::move(value)); return *this;} /** *

The labels that one or more rules in this rule group add to matching web * requests. These labels are defined in the RuleLabels for a * Rule.

*/ inline DescribeManagedRuleGroupResult& AddAvailableLabels(const LabelSummary& value) { m_availableLabels.push_back(value); return *this; } /** *

The labels that one or more rules in this rule group add to matching web * requests. These labels are defined in the RuleLabels for a * Rule.

*/ inline DescribeManagedRuleGroupResult& AddAvailableLabels(LabelSummary&& value) { m_availableLabels.push_back(std::move(value)); return *this; } /** *

The labels that one or more rules in this rule group match against in label * match statements. These labels are defined in a LabelMatchStatement * specification, in the Statement definition of a rule.

*/ inline const Aws::Vector& GetConsumedLabels() const{ return m_consumedLabels; } /** *

The labels that one or more rules in this rule group match against in label * match statements. These labels are defined in a LabelMatchStatement * specification, in the Statement definition of a rule.

*/ inline void SetConsumedLabels(const Aws::Vector& value) { m_consumedLabels = value; } /** *

The labels that one or more rules in this rule group match against in label * match statements. These labels are defined in a LabelMatchStatement * specification, in the Statement definition of a rule.

*/ inline void SetConsumedLabels(Aws::Vector&& value) { m_consumedLabels = std::move(value); } /** *

The labels that one or more rules in this rule group match against in label * match statements. These labels are defined in a LabelMatchStatement * specification, in the Statement definition of a rule.

*/ inline DescribeManagedRuleGroupResult& WithConsumedLabels(const Aws::Vector& value) { SetConsumedLabels(value); return *this;} /** *

The labels that one or more rules in this rule group match against in label * match statements. These labels are defined in a LabelMatchStatement * specification, in the Statement definition of a rule.

*/ inline DescribeManagedRuleGroupResult& WithConsumedLabels(Aws::Vector&& value) { SetConsumedLabels(std::move(value)); return *this;} /** *

The labels that one or more rules in this rule group match against in label * match statements. These labels are defined in a LabelMatchStatement * specification, in the Statement definition of a rule.

*/ inline DescribeManagedRuleGroupResult& AddConsumedLabels(const LabelSummary& value) { m_consumedLabels.push_back(value); return *this; } /** *

The labels that one or more rules in this rule group match against in label * match statements. These labels are defined in a LabelMatchStatement * specification, in the Statement definition of a rule.

*/ inline DescribeManagedRuleGroupResult& AddConsumedLabels(LabelSummary&& value) { m_consumedLabels.push_back(std::move(value)); return *this; } inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline DescribeManagedRuleGroupResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeManagedRuleGroupResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeManagedRuleGroupResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_versionName; Aws::String m_snsTopicArn; long long m_capacity; Aws::Vector m_rules; Aws::String m_labelNamespace; Aws::Vector m_availableLabels; Aws::Vector m_consumedLabels; Aws::String m_requestId; }; } // namespace Model } // namespace WAFV2 } // namespace Aws