/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include A web ACL defines a collection of rules to use to inspect and control web
* requests. Each rule has an action defined (allow, block, or count) for requests
* that match the statement of the rule. In the web ACL, you assign a default
* action to take (allow, block) for any request that does not match any of the
* rules. The rules in a web ACL can be a combination of the types Rule,
* RuleGroup, and managed rule group. You can associate a web ACL with one
* or more Amazon Web Services resources to protect. The resources can be an Amazon
* CloudFront distribution, an Amazon API Gateway REST API, an Application Load
* Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner
* service, or an Amazon Web Services Verified Access instance. See
* Also:
AWS API
* Reference
The name of the web ACL. You cannot change the name of a web ACL after you * create it.
*/ inline const Aws::String& GetName() const{ return m_name; } /** *The name of the web ACL. You cannot change the name of a web ACL after you * create it.
*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *The name of the web ACL. You cannot change the name of a web ACL after you * create it.
*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *The name of the web ACL. You cannot change the name of a web ACL after you * create it.
*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *The name of the web ACL. You cannot change the name of a web ACL after you * create it.
*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *The name of the web ACL. You cannot change the name of a web ACL after you * create it.
*/ inline WebACL& WithName(const Aws::String& value) { SetName(value); return *this;} /** *The name of the web ACL. You cannot change the name of a web ACL after you * create it.
*/ inline WebACL& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *The name of the web ACL. You cannot change the name of a web ACL after you * create it.
*/ inline WebACL& WithName(const char* value) { SetName(value); return *this;} /** *A unique identifier for the WebACL
. This ID is returned in the
* responses to create and list commands. You use this ID to do things like get,
* update, and delete a WebACL
.
A unique identifier for the WebACL
. This ID is returned in the
* responses to create and list commands. You use this ID to do things like get,
* update, and delete a WebACL
.
A unique identifier for the WebACL
. This ID is returned in the
* responses to create and list commands. You use this ID to do things like get,
* update, and delete a WebACL
.
A unique identifier for the WebACL
. This ID is returned in the
* responses to create and list commands. You use this ID to do things like get,
* update, and delete a WebACL
.
A unique identifier for the WebACL
. This ID is returned in the
* responses to create and list commands. You use this ID to do things like get,
* update, and delete a WebACL
.
A unique identifier for the WebACL
. This ID is returned in the
* responses to create and list commands. You use this ID to do things like get,
* update, and delete a WebACL
.
A unique identifier for the WebACL
. This ID is returned in the
* responses to create and list commands. You use this ID to do things like get,
* update, and delete a WebACL
.
A unique identifier for the WebACL
. This ID is returned in the
* responses to create and list commands. You use this ID to do things like get,
* update, and delete a WebACL
.
The Amazon Resource Name (ARN) of the web ACL that you want to associate with * the resource.
*/ inline const Aws::String& GetARN() const{ return m_aRN; } /** *The Amazon Resource Name (ARN) of the web ACL that you want to associate with * the resource.
*/ inline bool ARNHasBeenSet() const { return m_aRNHasBeenSet; } /** *The Amazon Resource Name (ARN) of the web ACL that you want to associate with * the resource.
*/ inline void SetARN(const Aws::String& value) { m_aRNHasBeenSet = true; m_aRN = value; } /** *The Amazon Resource Name (ARN) of the web ACL that you want to associate with * the resource.
*/ inline void SetARN(Aws::String&& value) { m_aRNHasBeenSet = true; m_aRN = std::move(value); } /** *The Amazon Resource Name (ARN) of the web ACL that you want to associate with * the resource.
*/ inline void SetARN(const char* value) { m_aRNHasBeenSet = true; m_aRN.assign(value); } /** *The Amazon Resource Name (ARN) of the web ACL that you want to associate with * the resource.
*/ inline WebACL& WithARN(const Aws::String& value) { SetARN(value); return *this;} /** *The Amazon Resource Name (ARN) of the web ACL that you want to associate with * the resource.
*/ inline WebACL& WithARN(Aws::String&& value) { SetARN(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) of the web ACL that you want to associate with * the resource.
*/ inline WebACL& WithARN(const char* value) { SetARN(value); return *this;} /** *The action to perform if none of the Rules
contained in the
* WebACL
match.
The action to perform if none of the Rules
contained in the
* WebACL
match.
The action to perform if none of the Rules
contained in the
* WebACL
match.
The action to perform if none of the Rules
contained in the
* WebACL
match.
The action to perform if none of the Rules
contained in the
* WebACL
match.
The action to perform if none of the Rules
contained in the
* WebACL
match.
A description of the web ACL that helps with identification.
*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *A description of the web ACL that helps with identification.
*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *A description of the web ACL that helps with identification.
*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *A description of the web ACL that helps with identification.
*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *A description of the web ACL that helps with identification.
*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *A description of the web ACL that helps with identification.
*/ inline WebACL& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *A description of the web ACL that helps with identification.
*/ inline WebACL& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *A description of the web ACL that helps with identification.
*/ inline WebACL& 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 WebACL& 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 WebACL& 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 WebACL& 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 WebACL& 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 WebACL& WithVisibilityConfig(const VisibilityConfig& value) { SetVisibilityConfig(value); return *this;} /** *Defines and enables Amazon CloudWatch metrics and web request sample * collection.
*/ inline WebACL& WithVisibilityConfig(VisibilityConfig&& value) { SetVisibilityConfig(std::move(value)); return *this;} /** *The web ACL capacity units (WCUs) currently being used by this web ACL.
*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) currently being used by this web ACL.
*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) currently being used by this web ACL.
*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) currently being used by this web ACL.
*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 WebACL& WithCapacity(long long value) { SetCapacity(value); return *this;} /** *The first set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized after these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline const Aws::VectorThe first set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized after these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline bool PreProcessFirewallManagerRuleGroupsHasBeenSet() const { return m_preProcessFirewallManagerRuleGroupsHasBeenSet; } /** *The first set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized after these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline void SetPreProcessFirewallManagerRuleGroups(const Aws::VectorThe first set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized after these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline void SetPreProcessFirewallManagerRuleGroups(Aws::VectorThe first set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized after these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline WebACL& WithPreProcessFirewallManagerRuleGroups(const Aws::VectorThe first set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized after these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline WebACL& WithPreProcessFirewallManagerRuleGroups(Aws::VectorThe first set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized after these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline WebACL& AddPreProcessFirewallManagerRuleGroups(const FirewallManagerRuleGroup& value) { m_preProcessFirewallManagerRuleGroupsHasBeenSet = true; m_preProcessFirewallManagerRuleGroups.push_back(value); return *this; } /** *The first set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized after these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline WebACL& AddPreProcessFirewallManagerRuleGroups(FirewallManagerRuleGroup&& value) { m_preProcessFirewallManagerRuleGroupsHasBeenSet = true; m_preProcessFirewallManagerRuleGroups.push_back(std::move(value)); return *this; } /** *The last set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized before these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline const Aws::VectorThe last set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized before these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline bool PostProcessFirewallManagerRuleGroupsHasBeenSet() const { return m_postProcessFirewallManagerRuleGroupsHasBeenSet; } /** *The last set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized before these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline void SetPostProcessFirewallManagerRuleGroups(const Aws::VectorThe last set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized before these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline void SetPostProcessFirewallManagerRuleGroups(Aws::VectorThe last set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized before these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline WebACL& WithPostProcessFirewallManagerRuleGroups(const Aws::VectorThe last set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized before these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline WebACL& WithPostProcessFirewallManagerRuleGroups(Aws::VectorThe last set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized before these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline WebACL& AddPostProcessFirewallManagerRuleGroups(const FirewallManagerRuleGroup& value) { m_postProcessFirewallManagerRuleGroupsHasBeenSet = true; m_postProcessFirewallManagerRuleGroups.push_back(value); return *this; } /** *The last set of rules for WAF to process in the web ACL. This is defined in * an Firewall Manager WAF policy and contains only rule group references. You * can't alter these. Any rules and rule groups that you define for the web ACL are * prioritized before these.
In the Firewall Manager WAF policy, the * Firewall Manager administrator can define a set of rule groups to run first in * the web ACL and a set of rule groups to run last. Within each set, the * administrator prioritizes the rule groups, to determine their relative * processing order.
*/ inline WebACL& AddPostProcessFirewallManagerRuleGroups(FirewallManagerRuleGroup&& value) { m_postProcessFirewallManagerRuleGroupsHasBeenSet = true; m_postProcessFirewallManagerRuleGroups.push_back(std::move(value)); return *this; } /** *Indicates whether this web ACL is managed by Firewall Manager. If true, then * only Firewall Manager can delete the web ACL or any Firewall Manager rule groups * in the web ACL.
*/ inline bool GetManagedByFirewallManager() const{ return m_managedByFirewallManager; } /** *Indicates whether this web ACL is managed by Firewall Manager. If true, then * only Firewall Manager can delete the web ACL or any Firewall Manager rule groups * in the web ACL.
*/ inline bool ManagedByFirewallManagerHasBeenSet() const { return m_managedByFirewallManagerHasBeenSet; } /** *Indicates whether this web ACL is managed by Firewall Manager. If true, then * only Firewall Manager can delete the web ACL or any Firewall Manager rule groups * in the web ACL.
*/ inline void SetManagedByFirewallManager(bool value) { m_managedByFirewallManagerHasBeenSet = true; m_managedByFirewallManager = value; } /** *Indicates whether this web ACL is managed by Firewall Manager. If true, then * only Firewall Manager can delete the web ACL or any Firewall Manager rule groups * in the web ACL.
*/ inline WebACL& WithManagedByFirewallManager(bool value) { SetManagedByFirewallManager(value); return *this;} /** *The label namespace prefix for this web ACL. All labels added by rules in * this web ACL have this prefix.
The syntax for the label * namespace prefix for a web ACL is the following:
* awswaf:<account ID>:webacl:<web ACL 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 web ACL. All labels added by rules in * this web ACL have this prefix.
The syntax for the label * namespace prefix for a web ACL is the following:
* awswaf:<account ID>:webacl:<web ACL 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 web ACL. All labels added by rules in * this web ACL have this prefix.
The syntax for the label * namespace prefix for a web ACL is the following:
* awswaf:<account ID>:webacl:<web ACL 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 web ACL. All labels added by rules in * this web ACL have this prefix.
The syntax for the label * namespace prefix for a web ACL is the following:
* awswaf:<account ID>:webacl:<web ACL 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 web ACL. All labels added by rules in * this web ACL have this prefix.
The syntax for the label * namespace prefix for a web ACL is the following:
* awswaf:<account ID>:webacl:<web ACL 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 web ACL. All labels added by rules in * this web ACL have this prefix.
The syntax for the label * namespace prefix for a web ACL is the following:
* awswaf:<account ID>:webacl:<web ACL 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 web ACL. All labels added by rules in * this web ACL have this prefix.
The syntax for the label * namespace prefix for a web ACL is the following:
* awswaf:<account ID>:webacl:<web ACL 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 web ACL. All labels added by rules in * this web ACL have this prefix.
The syntax for the label * namespace prefix for a web ACL is the following:
* awswaf:<account ID>:webacl:<web ACL 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 web ACL, and then use them in the rules and default actions that * you define in the web ACL.
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 web ACL, and then use them in the rules and default actions that * you define in the web ACL.
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 web ACL, and then use them in the rules and default actions that * you define in the web ACL.
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 web ACL, and then use them in the rules and default actions that * you define in the web ACL.
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 web ACL, and then use them in the rules and default actions that * you define in the web ACL.
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 WebACL& 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 web ACL, and then use them in the rules and default actions that * you define in the web ACL.
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 WebACL& 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 web ACL, and then use them in the rules and default actions that * you define in the web ACL.
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 WebACL& 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 web ACL, and then use them in the rules and default actions that * you define in the web ACL.
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 WebACL& 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 web ACL, and then use them in the rules and default actions that * you define in the web ACL.
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 WebACL& 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 web ACL, and then use them in the rules and default actions that * you define in the web ACL.
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 WebACL& 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 web ACL, and then use them in the rules and default actions that * you define in the web ACL.
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 WebACL& 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 web ACL, and then use them in the rules and default actions that * you define in the web ACL.
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 WebACL& AddCustomResponseBodies(const char* key, const CustomResponseBody& value) { m_customResponseBodiesHasBeenSet = true; m_customResponseBodies.emplace(key, value); return *this; } /** *Specifies how WAF should handle CAPTCHA
evaluations for rules
* that don't have their own CaptchaConfig
settings. If you don't
* specify this, WAF uses its default settings for CaptchaConfig
.
Specifies how WAF should handle CAPTCHA
evaluations for rules
* that don't have their own CaptchaConfig
settings. If you don't
* specify this, WAF uses its default settings for CaptchaConfig
.
Specifies how WAF should handle CAPTCHA
evaluations for rules
* that don't have their own CaptchaConfig
settings. If you don't
* specify this, WAF uses its default settings for CaptchaConfig
.
Specifies how WAF should handle CAPTCHA
evaluations for rules
* that don't have their own CaptchaConfig
settings. If you don't
* specify this, WAF uses its default settings for CaptchaConfig
.
Specifies how WAF should handle CAPTCHA
evaluations for rules
* that don't have their own CaptchaConfig
settings. If you don't
* specify this, WAF uses its default settings for CaptchaConfig
.
Specifies how WAF should handle CAPTCHA
evaluations for rules
* that don't have their own CaptchaConfig
settings. If you don't
* specify this, WAF uses its default settings for CaptchaConfig
.
Specifies how WAF should handle challenge evaluations for rules that don't
* have their own ChallengeConfig
settings. If you don't specify this,
* WAF uses its default settings for ChallengeConfig
.
Specifies how WAF should handle challenge evaluations for rules that don't
* have their own ChallengeConfig
settings. If you don't specify this,
* WAF uses its default settings for ChallengeConfig
.
Specifies how WAF should handle challenge evaluations for rules that don't
* have their own ChallengeConfig
settings. If you don't specify this,
* WAF uses its default settings for ChallengeConfig
.
Specifies how WAF should handle challenge evaluations for rules that don't
* have their own ChallengeConfig
settings. If you don't specify this,
* WAF uses its default settings for ChallengeConfig
.
Specifies how WAF should handle challenge evaluations for rules that don't
* have their own ChallengeConfig
settings. If you don't specify this,
* WAF uses its default settings for ChallengeConfig
.
Specifies how WAF should handle challenge evaluations for rules that don't
* have their own ChallengeConfig
settings. If you don't specify this,
* WAF uses its default settings for ChallengeConfig
.
Specifies the domains that WAF should accept in a web request token. This * enables the use of tokens across multiple protected websites. When WAF provides * a token, it uses the domain of the Amazon Web Services resource that the web ACL * is protecting. If you don't specify a list of token domains, WAF accepts tokens * only for the domain of the protected resource. With a token domain list, WAF * accepts the resource's host domain plus all domains in the token domain list, * including their prefixed subdomains.
*/ inline const Aws::VectorSpecifies the domains that WAF should accept in a web request token. This * enables the use of tokens across multiple protected websites. When WAF provides * a token, it uses the domain of the Amazon Web Services resource that the web ACL * is protecting. If you don't specify a list of token domains, WAF accepts tokens * only for the domain of the protected resource. With a token domain list, WAF * accepts the resource's host domain plus all domains in the token domain list, * including their prefixed subdomains.
*/ inline bool TokenDomainsHasBeenSet() const { return m_tokenDomainsHasBeenSet; } /** *Specifies the domains that WAF should accept in a web request token. This * enables the use of tokens across multiple protected websites. When WAF provides * a token, it uses the domain of the Amazon Web Services resource that the web ACL * is protecting. If you don't specify a list of token domains, WAF accepts tokens * only for the domain of the protected resource. With a token domain list, WAF * accepts the resource's host domain plus all domains in the token domain list, * including their prefixed subdomains.
*/ inline void SetTokenDomains(const Aws::VectorSpecifies the domains that WAF should accept in a web request token. This * enables the use of tokens across multiple protected websites. When WAF provides * a token, it uses the domain of the Amazon Web Services resource that the web ACL * is protecting. If you don't specify a list of token domains, WAF accepts tokens * only for the domain of the protected resource. With a token domain list, WAF * accepts the resource's host domain plus all domains in the token domain list, * including their prefixed subdomains.
*/ inline void SetTokenDomains(Aws::VectorSpecifies the domains that WAF should accept in a web request token. This * enables the use of tokens across multiple protected websites. When WAF provides * a token, it uses the domain of the Amazon Web Services resource that the web ACL * is protecting. If you don't specify a list of token domains, WAF accepts tokens * only for the domain of the protected resource. With a token domain list, WAF * accepts the resource's host domain plus all domains in the token domain list, * including their prefixed subdomains.
*/ inline WebACL& WithTokenDomains(const Aws::VectorSpecifies the domains that WAF should accept in a web request token. This * enables the use of tokens across multiple protected websites. When WAF provides * a token, it uses the domain of the Amazon Web Services resource that the web ACL * is protecting. If you don't specify a list of token domains, WAF accepts tokens * only for the domain of the protected resource. With a token domain list, WAF * accepts the resource's host domain plus all domains in the token domain list, * including their prefixed subdomains.
*/ inline WebACL& WithTokenDomains(Aws::VectorSpecifies the domains that WAF should accept in a web request token. This * enables the use of tokens across multiple protected websites. When WAF provides * a token, it uses the domain of the Amazon Web Services resource that the web ACL * is protecting. If you don't specify a list of token domains, WAF accepts tokens * only for the domain of the protected resource. With a token domain list, WAF * accepts the resource's host domain plus all domains in the token domain list, * including their prefixed subdomains.
*/ inline WebACL& AddTokenDomains(const Aws::String& value) { m_tokenDomainsHasBeenSet = true; m_tokenDomains.push_back(value); return *this; } /** *Specifies the domains that WAF should accept in a web request token. This * enables the use of tokens across multiple protected websites. When WAF provides * a token, it uses the domain of the Amazon Web Services resource that the web ACL * is protecting. If you don't specify a list of token domains, WAF accepts tokens * only for the domain of the protected resource. With a token domain list, WAF * accepts the resource's host domain plus all domains in the token domain list, * including their prefixed subdomains.
*/ inline WebACL& AddTokenDomains(Aws::String&& value) { m_tokenDomainsHasBeenSet = true; m_tokenDomains.push_back(std::move(value)); return *this; } /** *Specifies the domains that WAF should accept in a web request token. This * enables the use of tokens across multiple protected websites. When WAF provides * a token, it uses the domain of the Amazon Web Services resource that the web ACL * is protecting. If you don't specify a list of token domains, WAF accepts tokens * only for the domain of the protected resource. With a token domain list, WAF * accepts the resource's host domain plus all domains in the token domain list, * including their prefixed subdomains.
*/ inline WebACL& AddTokenDomains(const char* value) { m_tokenDomainsHasBeenSet = true; m_tokenDomains.push_back(value); return *this; } /** *Specifies custom configurations for the associations between the web ACL and * protected resources.
Use this to customize the maximum size of the * request body that your protected CloudFront distributions forward to WAF for * inspection. The default is 16 KB (16,384 kilobytes).
You are * charged additional fees when your protected resources forward body sizes that * are larger than the default. For more information, see WAF Pricing.
*/ inline const AssociationConfig& GetAssociationConfig() const{ return m_associationConfig; } /** *Specifies custom configurations for the associations between the web ACL and * protected resources.
Use this to customize the maximum size of the * request body that your protected CloudFront distributions forward to WAF for * inspection. The default is 16 KB (16,384 kilobytes).
You are * charged additional fees when your protected resources forward body sizes that * are larger than the default. For more information, see WAF Pricing.
*/ inline bool AssociationConfigHasBeenSet() const { return m_associationConfigHasBeenSet; } /** *Specifies custom configurations for the associations between the web ACL and * protected resources.
Use this to customize the maximum size of the * request body that your protected CloudFront distributions forward to WAF for * inspection. The default is 16 KB (16,384 kilobytes).
You are * charged additional fees when your protected resources forward body sizes that * are larger than the default. For more information, see WAF Pricing.
*/ inline void SetAssociationConfig(const AssociationConfig& value) { m_associationConfigHasBeenSet = true; m_associationConfig = value; } /** *Specifies custom configurations for the associations between the web ACL and * protected resources.
Use this to customize the maximum size of the * request body that your protected CloudFront distributions forward to WAF for * inspection. The default is 16 KB (16,384 kilobytes).
You are * charged additional fees when your protected resources forward body sizes that * are larger than the default. For more information, see WAF Pricing.
*/ inline void SetAssociationConfig(AssociationConfig&& value) { m_associationConfigHasBeenSet = true; m_associationConfig = std::move(value); } /** *Specifies custom configurations for the associations between the web ACL and * protected resources.
Use this to customize the maximum size of the * request body that your protected CloudFront distributions forward to WAF for * inspection. The default is 16 KB (16,384 kilobytes).
You are * charged additional fees when your protected resources forward body sizes that * are larger than the default. For more information, see WAF Pricing.
*/ inline WebACL& WithAssociationConfig(const AssociationConfig& value) { SetAssociationConfig(value); return *this;} /** *Specifies custom configurations for the associations between the web ACL and * protected resources.
Use this to customize the maximum size of the * request body that your protected CloudFront distributions forward to WAF for * inspection. The default is 16 KB (16,384 kilobytes).
You are * charged additional fees when your protected resources forward body sizes that * are larger than the default. For more information, see WAF Pricing.
*/ inline WebACL& WithAssociationConfig(AssociationConfig&& value) { SetAssociationConfig(std::move(value)); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_id; bool m_idHasBeenSet = false; Aws::String m_aRN; bool m_aRNHasBeenSet = false; DefaultAction m_defaultAction; bool m_defaultActionHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::Vector