/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include A rule group defines a collection of rules to inspect and control web
* requests that you can use in a WebACL. When you create a rule group, you
* define an immutable capacity limit. If you update a rule group, you must stay
* within the capacity. This allows others to reuse the rule group with confidence
* in its capacity requirements. See Also:
AWS API
* Reference
The name of the rule group. You cannot change the name of a rule group after * you create it.
*/ inline const Aws::String& GetName() const{ return m_name; } /** *The name of the rule group. You cannot change the name of a rule group after * you create it.
*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *The name of the rule group. You cannot change the name of a rule group after * you create it.
*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *The name of the rule group. You cannot change the name of a rule group after * you create it.
*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *The name of the rule group. You cannot change the name of a rule group after * you create it.
*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *The name of the rule group. You cannot change the name of a rule group after * you create it.
*/ inline RuleGroup& WithName(const Aws::String& value) { SetName(value); return *this;} /** *The name of the rule group. You cannot change the name of a rule group after * you create it.
*/ inline RuleGroup& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *The name of the rule group. You cannot change the name of a rule group after * you create it.
*/ inline RuleGroup& WithName(const char* value) { SetName(value); return *this;} /** *A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.
*/ inline const Aws::String& GetId() const{ return m_id; } /** *A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.
*/ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** *A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.
*/ inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; } /** *A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.
*/ inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); } /** *A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.
*/ inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); } /** *A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.
*/ inline RuleGroup& WithId(const Aws::String& value) { SetId(value); return *this;} /** *A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.
*/ inline RuleGroup& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** *A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.
*/ inline RuleGroup& WithId(const char* value) { SetId(value); return *this;} /** *The web ACL capacity units (WCUs) required for this rule group.
When * you create your own rule group, you define this, and you cannot change it after * creation. When you add or modify the rules in a rule group, WAF enforces this * limit. You can check the capacity for a set of rules using * CheckCapacity.
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.
When * you create your own rule group, you define this, and you cannot change it after * creation. When you add or modify the rules in a rule group, WAF enforces this * limit. You can check the capacity for a set of rules using * CheckCapacity.
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 bool CapacityHasBeenSet() const { return m_capacityHasBeenSet; } /** *The web ACL capacity units (WCUs) required for this rule group.
When * you create your own rule group, you define this, and you cannot change it after * creation. When you add or modify the rules in a rule group, WAF enforces this * limit. You can check the capacity for a set of rules using * CheckCapacity.
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_capacityHasBeenSet = true; m_capacity = value; } /** *The web ACL capacity units (WCUs) required for this rule group.
When * you create your own rule group, you define this, and you cannot change it after * creation. When you add or modify the rules in a rule group, WAF enforces this * limit. You can check the capacity for a set of rules using * CheckCapacity.
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 RuleGroup& WithCapacity(long long value) { SetCapacity(value); return *this;} /** *The Amazon Resource Name (ARN) of the entity.
*/ inline const Aws::String& GetARN() const{ return m_aRN; } /** *The Amazon Resource Name (ARN) of the entity.
*/ inline bool ARNHasBeenSet() const { return m_aRNHasBeenSet; } /** *The Amazon Resource Name (ARN) of the entity.
*/ inline void SetARN(const Aws::String& value) { m_aRNHasBeenSet = true; m_aRN = value; } /** *The Amazon Resource Name (ARN) of the entity.
*/ inline void SetARN(Aws::String&& value) { m_aRNHasBeenSet = true; m_aRN = std::move(value); } /** *The Amazon Resource Name (ARN) of the entity.
*/ inline void SetARN(const char* value) { m_aRNHasBeenSet = true; m_aRN.assign(value); } /** *The Amazon Resource Name (ARN) of the entity.
*/ inline RuleGroup& WithARN(const Aws::String& value) { SetARN(value); return *this;} /** *The Amazon Resource Name (ARN) of the entity.
*/ inline RuleGroup& WithARN(Aws::String&& value) { SetARN(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) of the entity.
*/ inline RuleGroup& WithARN(const char* value) { SetARN(value); return *this;} /** *A description of the rule group that helps with identification.
*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *A description of the rule group that helps with identification.
*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *A description of the rule group that helps with identification.
*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *A description of the rule group that helps with identification.
*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *A description of the rule group that helps with identification.
*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *A description of the rule group that helps with identification.
*/ inline RuleGroup& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *A description of the rule group that helps with identification.
*/ inline RuleGroup& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *A description of the rule group that helps with identification.
*/ inline RuleGroup& WithDescription(const char* value) { SetDescription(value); return *this;} /** *The Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that WAF uses * to identify matching web requests, and parameters that govern how WAF handles * them.
*/ inline const Aws::VectorThe Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that WAF uses * to identify matching web requests, and parameters that govern how WAF handles * them.
*/ inline bool RulesHasBeenSet() const { return m_rulesHasBeenSet; } /** *The Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that WAF uses * to identify matching web requests, and parameters that govern how WAF handles * them.
*/ inline void SetRules(const Aws::VectorThe Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that WAF uses * to identify matching web requests, and parameters that govern how WAF handles * them.
*/ inline void SetRules(Aws::VectorThe Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that WAF uses * to identify matching web requests, and parameters that govern how WAF handles * them.
*/ inline RuleGroup& WithRules(const Aws::VectorThe Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that WAF uses * to identify matching web requests, and parameters that govern how WAF handles * them.
*/ inline RuleGroup& WithRules(Aws::VectorThe Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that WAF uses * to identify matching web requests, and parameters that govern how WAF handles * them.
*/ inline RuleGroup& AddRules(const Rule& value) { m_rulesHasBeenSet = true; m_rules.push_back(value); return *this; } /** *The Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that WAF uses * to identify matching web requests, and parameters that govern how WAF handles * them.
*/ inline RuleGroup& AddRules(Rule&& value) { m_rulesHasBeenSet = true; m_rules.push_back(std::move(value)); return *this; } /** *Defines and enables Amazon CloudWatch metrics and web request sample * collection.
*/ inline const VisibilityConfig& GetVisibilityConfig() const{ return m_visibilityConfig; } /** *Defines and enables Amazon CloudWatch metrics and web request sample * collection.
*/ inline bool VisibilityConfigHasBeenSet() const { return m_visibilityConfigHasBeenSet; } /** *Defines and enables Amazon CloudWatch metrics and web request sample * collection.
*/ inline void SetVisibilityConfig(const VisibilityConfig& value) { m_visibilityConfigHasBeenSet = true; m_visibilityConfig = value; } /** *Defines and enables Amazon CloudWatch metrics and web request sample * collection.
*/ inline void SetVisibilityConfig(VisibilityConfig&& value) { m_visibilityConfigHasBeenSet = true; m_visibilityConfig = std::move(value); } /** *Defines and enables Amazon CloudWatch metrics and web request sample * collection.
*/ inline RuleGroup& WithVisibilityConfig(const VisibilityConfig& value) { SetVisibilityConfig(value); return *this;} /** *Defines and enables Amazon CloudWatch metrics and web request sample * collection.
*/ inline RuleGroup& WithVisibilityConfig(VisibilityConfig&& value) { SetVisibilityConfig(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 your rule groups is the following:
* awswaf:<account ID>:rulegroup:<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>
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 your rule groups is the following:
* awswaf:<account ID>:rulegroup:<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>
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 your rule groups is the following:
* awswaf:<account ID>:rulegroup:<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>
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 your rule groups is the following:
* awswaf:<account ID>:rulegroup:<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>
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 your rule groups is the following:
* awswaf:<account ID>:rulegroup:<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>
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 your rule groups is the following:
* awswaf:<account ID>:rulegroup:<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>
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 your rule groups is the following:
* awswaf:<account ID>:rulegroup:<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>
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 your rule groups is the following:
* awswaf:<account ID>:rulegroup:<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>
A map of custom response keys and content bodies. When you create a rule with * a block action, you can send a custom response to the web request. You define * these for the rule group, and then use them in the rules that you define in the * rule group.
For information about customizing web requests and * responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide.
*For information about the limits on count and size for custom request and * response settings, see WAF * quotas in the WAF Developer Guide.
*/ inline const Aws::MapA map of custom response keys and content bodies. When you create a rule with * a block action, you can send a custom response to the web request. You define * these for the rule group, and then use them in the rules that you define in the * rule group.
For information about customizing web requests and * responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide.
*For information about the limits on count and size for custom request and * response settings, see WAF * quotas in the WAF Developer Guide.
*/ inline bool CustomResponseBodiesHasBeenSet() const { return m_customResponseBodiesHasBeenSet; } /** *A map of custom response keys and content bodies. When you create a rule with * a block action, you can send a custom response to the web request. You define * these for the rule group, and then use them in the rules that you define in the * rule group.
For information about customizing web requests and * responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide.
*For information about the limits on count and size for custom request and * response settings, see WAF * quotas in the WAF Developer Guide.
*/ inline void SetCustomResponseBodies(const Aws::MapA map of custom response keys and content bodies. When you create a rule with * a block action, you can send a custom response to the web request. You define * these for the rule group, and then use them in the rules that you define in the * rule group.
For information about customizing web requests and * responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide.
*For information about the limits on count and size for custom request and * response settings, see WAF * quotas in the WAF Developer Guide.
*/ inline void SetCustomResponseBodies(Aws::MapA map of custom response keys and content bodies. When you create a rule with * a block action, you can send a custom response to the web request. You define * these for the rule group, and then use them in the rules that you define in the * rule group.
For information about customizing web requests and * responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide.
*For information about the limits on count and size for custom request and * response settings, see WAF * quotas in the WAF Developer Guide.
*/ inline RuleGroup& WithCustomResponseBodies(const Aws::MapA map of custom response keys and content bodies. When you create a rule with * a block action, you can send a custom response to the web request. You define * these for the rule group, and then use them in the rules that you define in the * rule group.
For information about customizing web requests and * responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide.
*For information about the limits on count and size for custom request and * response settings, see WAF * quotas in the WAF Developer Guide.
*/ inline RuleGroup& WithCustomResponseBodies(Aws::MapA map of custom response keys and content bodies. When you create a rule with * a block action, you can send a custom response to the web request. You define * these for the rule group, and then use them in the rules that you define in the * rule group.
For information about customizing web requests and * responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide.
*For information about the limits on count and size for custom request and * response settings, see WAF * quotas in the WAF Developer Guide.
*/ inline RuleGroup& AddCustomResponseBodies(const Aws::String& key, const CustomResponseBody& value) { m_customResponseBodiesHasBeenSet = true; m_customResponseBodies.emplace(key, value); return *this; } /** *A map of custom response keys and content bodies. When you create a rule with * a block action, you can send a custom response to the web request. You define * these for the rule group, and then use them in the rules that you define in the * rule group.
For information about customizing web requests and * responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide.
*For information about the limits on count and size for custom request and * response settings, see WAF * quotas in the WAF Developer Guide.
*/ inline RuleGroup& AddCustomResponseBodies(Aws::String&& key, const CustomResponseBody& value) { m_customResponseBodiesHasBeenSet = true; m_customResponseBodies.emplace(std::move(key), value); return *this; } /** *A map of custom response keys and content bodies. When you create a rule with * a block action, you can send a custom response to the web request. You define * these for the rule group, and then use them in the rules that you define in the * rule group.
For information about customizing web requests and * responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide.
*For information about the limits on count and size for custom request and * response settings, see WAF * quotas in the WAF Developer Guide.
*/ inline RuleGroup& AddCustomResponseBodies(const Aws::String& key, CustomResponseBody&& value) { m_customResponseBodiesHasBeenSet = true; m_customResponseBodies.emplace(key, std::move(value)); return *this; } /** *A map of custom response keys and content bodies. When you create a rule with * a block action, you can send a custom response to the web request. You define * these for the rule group, and then use them in the rules that you define in the * rule group.
For information about customizing web requests and * responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide.
*For information about the limits on count and size for custom request and * response settings, see WAF * quotas in the WAF Developer Guide.
*/ inline RuleGroup& AddCustomResponseBodies(Aws::String&& key, CustomResponseBody&& value) { m_customResponseBodiesHasBeenSet = true; m_customResponseBodies.emplace(std::move(key), std::move(value)); return *this; } /** *A map of custom response keys and content bodies. When you create a rule with * a block action, you can send a custom response to the web request. You define * these for the rule group, and then use them in the rules that you define in the * rule group.
For information about customizing web requests and * responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide.
*For information about the limits on count and size for custom request and * response settings, see WAF * quotas in the WAF Developer Guide.
*/ inline RuleGroup& AddCustomResponseBodies(const char* key, CustomResponseBody&& value) { m_customResponseBodiesHasBeenSet = true; m_customResponseBodies.emplace(key, std::move(value)); return *this; } /** *A map of custom response keys and content bodies. When you create a rule with * a block action, you can send a custom response to the web request. You define * these for the rule group, and then use them in the rules that you define in the * rule group.
For information about customizing web requests and * responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide.
*For information about the limits on count and size for custom request and * response settings, see WAF * quotas in the WAF Developer Guide.
*/ inline RuleGroup& AddCustomResponseBodies(const char* key, const CustomResponseBody& value) { m_customResponseBodiesHasBeenSet = true; m_customResponseBodies.emplace(key, 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.