/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include This is the latest version of AWS WAF, named AWS WAFV2,
* released in November, 2019. For information, including how to migrate your AWS
* WAF resources from the prior release, see the AWS
* WAF Developer Guide. 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 AWS resources to protect. The
* resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application
* Load Balancer. 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. You cannot * change the description of a Web ACL after you create it.
*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *A description of the Web ACL that helps with identification. You cannot * change the description of a Web ACL after you create it.
*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *A description of the Web ACL that helps with identification. You cannot * change the description of a Web ACL after you create it.
*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *A description of the Web ACL that helps with identification. You cannot * change the description of a Web ACL after you create it.
*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *A description of the Web ACL that helps with identification. You cannot * change the description of a Web ACL after you create it.
*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *A description of the Web ACL that helps with identification. You cannot * change the description of a Web ACL after you create it.
*/ inline WebACL& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *A description of the Web ACL that helps with identification. You cannot * change the description of a Web ACL after you create it.
*/ inline WebACL& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *A description of the Web ACL that helps with identification. You cannot * change the description of a Web ACL after you create it.
*/ 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 AWS WAF * uses to identify matching web requests, and parameters that govern how AWS 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 AWS WAF * uses to identify matching web requests, and parameters that govern how AWS 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 AWS WAF * uses to identify matching web requests, and parameters that govern how AWS 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 AWS WAF * uses to identify matching web requests, and parameters that govern how AWS 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 AWS WAF * uses to identify matching web requests, and parameters that govern how AWS 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 AWS WAF * uses to identify matching web requests, and parameters that govern how AWS 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 AWS WAF * uses to identify matching web requests, and parameters that govern how AWS 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 AWS WAF * uses to identify matching web requests, and parameters that govern how AWS 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.
*AWS WAF uses WCUs to calculate and control the operating resources that are * used to run your rules, rule groups, and web ACLs. AWS 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. The WCU limit for * web ACLs is 1,500.
*/ inline long long GetCapacity() const{ return m_capacity; } /** *The web ACL capacity units (WCUs) currently being used by this web ACL.
*AWS WAF uses WCUs to calculate and control the operating resources that are * used to run your rules, rule groups, and web ACLs. AWS 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. The WCU limit for * web ACLs is 1,500.
*/ inline bool CapacityHasBeenSet() const { return m_capacityHasBeenSet; } /** *The web ACL capacity units (WCUs) currently being used by this web ACL.
*AWS WAF uses WCUs to calculate and control the operating resources that are * used to run your rules, rule groups, and web ACLs. AWS 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. The WCU limit for * web ACLs is 1,500.
*/ 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.
*AWS WAF uses WCUs to calculate and control the operating resources that are * used to run your rules, rule groups, and web ACLs. AWS 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. The WCU limit for * web ACLs is 1,500.
*/ inline WebACL& WithCapacity(long long value) { SetCapacity(value); return *this;} /** *The first set of rules for AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS WAF to process in the web ACL. This is defined * in an AWS 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 AWS Firewall Manager. If true, * then only AWS 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 AWS Firewall Manager. If true, * then only AWS 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 AWS Firewall Manager. If true, * then only AWS 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 AWS Firewall Manager. If true, * then only AWS 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;} private: Aws::String m_name; bool m_nameHasBeenSet; Aws::String m_id; bool m_idHasBeenSet; Aws::String m_aRN; bool m_aRNHasBeenSet; DefaultAction m_defaultAction; bool m_defaultActionHasBeenSet; Aws::String m_description; bool m_descriptionHasBeenSet; Aws::Vector