AWS SDK for C++  1.9.43
AWS SDK for C++
Public Member Functions | List of all members
Aws::WAFV2::Model::RuleGroup Class Reference

#include <RuleGroup.h>

Public Member Functions

 RuleGroup ()
 
 RuleGroup (Aws::Utils::Json::JsonView jsonValue)
 
RuleGroupoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
RuleGroupWithName (const Aws::String &value)
 
RuleGroupWithName (Aws::String &&value)
 
RuleGroupWithName (const char *value)
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
RuleGroupWithId (const Aws::String &value)
 
RuleGroupWithId (Aws::String &&value)
 
RuleGroupWithId (const char *value)
 
long long GetCapacity () const
 
bool CapacityHasBeenSet () const
 
void SetCapacity (long long value)
 
RuleGroupWithCapacity (long long value)
 
const Aws::StringGetARN () const
 
bool ARNHasBeenSet () const
 
void SetARN (const Aws::String &value)
 
void SetARN (Aws::String &&value)
 
void SetARN (const char *value)
 
RuleGroupWithARN (const Aws::String &value)
 
RuleGroupWithARN (Aws::String &&value)
 
RuleGroupWithARN (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
RuleGroupWithDescription (const Aws::String &value)
 
RuleGroupWithDescription (Aws::String &&value)
 
RuleGroupWithDescription (const char *value)
 
const Aws::Vector< Rule > & GetRules () const
 
bool RulesHasBeenSet () const
 
void SetRules (const Aws::Vector< Rule > &value)
 
void SetRules (Aws::Vector< Rule > &&value)
 
RuleGroupWithRules (const Aws::Vector< Rule > &value)
 
RuleGroupWithRules (Aws::Vector< Rule > &&value)
 
RuleGroupAddRules (const Rule &value)
 
RuleGroupAddRules (Rule &&value)
 
const VisibilityConfigGetVisibilityConfig () const
 
bool VisibilityConfigHasBeenSet () const
 
void SetVisibilityConfig (const VisibilityConfig &value)
 
void SetVisibilityConfig (VisibilityConfig &&value)
 
RuleGroupWithVisibilityConfig (const VisibilityConfig &value)
 
RuleGroupWithVisibilityConfig (VisibilityConfig &&value)
 
const Aws::StringGetLabelNamespace () const
 
bool LabelNamespaceHasBeenSet () const
 
void SetLabelNamespace (const Aws::String &value)
 
void SetLabelNamespace (Aws::String &&value)
 
void SetLabelNamespace (const char *value)
 
RuleGroupWithLabelNamespace (const Aws::String &value)
 
RuleGroupWithLabelNamespace (Aws::String &&value)
 
RuleGroupWithLabelNamespace (const char *value)
 
const Aws::Map< Aws::String, CustomResponseBody > & GetCustomResponseBodies () const
 
bool CustomResponseBodiesHasBeenSet () const
 
void SetCustomResponseBodies (const Aws::Map< Aws::String, CustomResponseBody > &value)
 
void SetCustomResponseBodies (Aws::Map< Aws::String, CustomResponseBody > &&value)
 
RuleGroupWithCustomResponseBodies (const Aws::Map< Aws::String, CustomResponseBody > &value)
 
RuleGroupWithCustomResponseBodies (Aws::Map< Aws::String, CustomResponseBody > &&value)
 
RuleGroupAddCustomResponseBodies (const Aws::String &key, const CustomResponseBody &value)
 
RuleGroupAddCustomResponseBodies (Aws::String &&key, const CustomResponseBody &value)
 
RuleGroupAddCustomResponseBodies (const Aws::String &key, CustomResponseBody &&value)
 
RuleGroupAddCustomResponseBodies (Aws::String &&key, CustomResponseBody &&value)
 
RuleGroupAddCustomResponseBodies (const char *key, CustomResponseBody &&value)
 
RuleGroupAddCustomResponseBodies (const char *key, const CustomResponseBody &value)
 
const Aws::Vector< LabelSummary > & GetAvailableLabels () const
 
bool AvailableLabelsHasBeenSet () const
 
void SetAvailableLabels (const Aws::Vector< LabelSummary > &value)
 
void SetAvailableLabels (Aws::Vector< LabelSummary > &&value)
 
RuleGroupWithAvailableLabels (const Aws::Vector< LabelSummary > &value)
 
RuleGroupWithAvailableLabels (Aws::Vector< LabelSummary > &&value)
 
RuleGroupAddAvailableLabels (const LabelSummary &value)
 
RuleGroupAddAvailableLabels (LabelSummary &&value)
 
const Aws::Vector< LabelSummary > & GetConsumedLabels () const
 
bool ConsumedLabelsHasBeenSet () const
 
void SetConsumedLabels (const Aws::Vector< LabelSummary > &value)
 
void SetConsumedLabels (Aws::Vector< LabelSummary > &&value)
 
RuleGroupWithConsumedLabels (const Aws::Vector< LabelSummary > &value)
 
RuleGroupWithConsumedLabels (Aws::Vector< LabelSummary > &&value)
 
RuleGroupAddConsumedLabels (const LabelSummary &value)
 
RuleGroupAddConsumedLabels (LabelSummary &&value)
 

Detailed Description

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

Definition at line 41 of file RuleGroup.h.

Constructor & Destructor Documentation

◆ RuleGroup() [1/2]

Aws::WAFV2::Model::RuleGroup::RuleGroup ( )

◆ RuleGroup() [2/2]

Aws::WAFV2::Model::RuleGroup::RuleGroup ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddAvailableLabels() [1/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::AddAvailableLabels ( const LabelSummary value)
inline

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

Definition at line 770 of file RuleGroup.h.

◆ AddAvailableLabels() [2/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::AddAvailableLabels ( LabelSummary &&  value)
inline

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

Definition at line 777 of file RuleGroup.h.

◆ AddConsumedLabels() [1/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::AddConsumedLabels ( const LabelSummary value)
inline

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.

Definition at line 827 of file RuleGroup.h.

◆ AddConsumedLabels() [2/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::AddConsumedLabels ( LabelSummary &&  value)
inline

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.

Definition at line 834 of file RuleGroup.h.

◆ AddCustomResponseBodies() [1/6]

RuleGroup& Aws::WAFV2::Model::RuleGroup::AddCustomResponseBodies ( Aws::String &&  key,
const CustomResponseBody value 
)
inline

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 AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 648 of file RuleGroup.h.

◆ AddCustomResponseBodies() [2/6]

RuleGroup& Aws::WAFV2::Model::RuleGroup::AddCustomResponseBodies ( Aws::String &&  key,
CustomResponseBody &&  value 
)
inline

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 AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 684 of file RuleGroup.h.

◆ AddCustomResponseBodies() [3/6]

RuleGroup& Aws::WAFV2::Model::RuleGroup::AddCustomResponseBodies ( const Aws::String key,
const CustomResponseBody value 
)
inline

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 AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 630 of file RuleGroup.h.

◆ AddCustomResponseBodies() [4/6]

RuleGroup& Aws::WAFV2::Model::RuleGroup::AddCustomResponseBodies ( const Aws::String key,
CustomResponseBody &&  value 
)
inline

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 AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 666 of file RuleGroup.h.

◆ AddCustomResponseBodies() [5/6]

RuleGroup& Aws::WAFV2::Model::RuleGroup::AddCustomResponseBodies ( const char *  key,
const CustomResponseBody value 
)
inline

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 AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 720 of file RuleGroup.h.

◆ AddCustomResponseBodies() [6/6]

RuleGroup& Aws::WAFV2::Model::RuleGroup::AddCustomResponseBodies ( const char *  key,
CustomResponseBody &&  value 
)
inline

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 AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 702 of file RuleGroup.h.

◆ AddRules() [1/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::AddRules ( const Rule value)
inline

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.

Definition at line 353 of file RuleGroup.h.

◆ AddRules() [2/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::AddRules ( Rule &&  value)
inline

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.

Definition at line 361 of file RuleGroup.h.

◆ ARNHasBeenSet()

bool Aws::WAFV2::Model::RuleGroup::ARNHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 225 of file RuleGroup.h.

◆ AvailableLabelsHasBeenSet()

bool Aws::WAFV2::Model::RuleGroup::AvailableLabelsHasBeenSet ( ) const
inline

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

Definition at line 735 of file RuleGroup.h.

◆ CapacityHasBeenSet()

bool Aws::WAFV2::Model::RuleGroup::CapacityHasBeenSet ( ) const
inline

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, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

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.

Definition at line 184 of file RuleGroup.h.

◆ ConsumedLabelsHasBeenSet()

bool Aws::WAFV2::Model::RuleGroup::ConsumedLabelsHasBeenSet ( ) const
inline

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.

Definition at line 792 of file RuleGroup.h.

◆ CustomResponseBodiesHasBeenSet()

bool Aws::WAFV2::Model::RuleGroup::CustomResponseBodiesHasBeenSet ( ) const
inline

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 AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 540 of file RuleGroup.h.

◆ DescriptionHasBeenSet()

bool Aws::WAFV2::Model::RuleGroup::DescriptionHasBeenSet ( ) const
inline

A description of the rule group that helps with identification.

Definition at line 266 of file RuleGroup.h.

◆ GetARN()

const Aws::String& Aws::WAFV2::Model::RuleGroup::GetARN ( ) const
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 220 of file RuleGroup.h.

◆ GetAvailableLabels()

const Aws::Vector<LabelSummary>& Aws::WAFV2::Model::RuleGroup::GetAvailableLabels ( ) const
inline

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

Definition at line 728 of file RuleGroup.h.

◆ GetCapacity()

long long Aws::WAFV2::Model::RuleGroup::GetCapacity ( ) const
inline

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, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

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.

Definition at line 169 of file RuleGroup.h.

◆ GetConsumedLabels()

const Aws::Vector<LabelSummary>& Aws::WAFV2::Model::RuleGroup::GetConsumedLabels ( ) const
inline

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.

Definition at line 785 of file RuleGroup.h.

◆ GetCustomResponseBodies()

const Aws::Map<Aws::String, CustomResponseBody>& Aws::WAFV2::Model::RuleGroup::GetCustomResponseBodies ( ) const
inline

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 AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 522 of file RuleGroup.h.

◆ GetDescription()

const Aws::String& Aws::WAFV2::Model::RuleGroup::GetDescription ( ) const
inline

A description of the rule group that helps with identification.

Definition at line 261 of file RuleGroup.h.

◆ GetId()

const Aws::String& Aws::WAFV2::Model::RuleGroup::GetId ( ) const
inline

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.

Definition at line 104 of file RuleGroup.h.

◆ GetLabelNamespace()

const Aws::String& Aws::WAFV2::Model::RuleGroup::GetLabelNamespace ( ) const
inline

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, AWS 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>

Definition at line 412 of file RuleGroup.h.

◆ GetName()

const Aws::String& Aws::WAFV2::Model::RuleGroup::GetName ( ) const
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 54 of file RuleGroup.h.

◆ GetRules()

const Aws::Vector<Rule>& Aws::WAFV2::Model::RuleGroup::GetRules ( ) const
inline

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.

Definition at line 305 of file RuleGroup.h.

◆ GetVisibilityConfig()

const VisibilityConfig& Aws::WAFV2::Model::RuleGroup::GetVisibilityConfig ( ) const
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 368 of file RuleGroup.h.

◆ IdHasBeenSet()

bool Aws::WAFV2::Model::RuleGroup::IdHasBeenSet ( ) const
inline

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.

Definition at line 111 of file RuleGroup.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::WAFV2::Model::RuleGroup::Jsonize ( ) const

◆ LabelNamespaceHasBeenSet()

bool Aws::WAFV2::Model::RuleGroup::LabelNamespaceHasBeenSet ( ) const
inline

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, AWS 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>

Definition at line 425 of file RuleGroup.h.

◆ NameHasBeenSet()

bool Aws::WAFV2::Model::RuleGroup::NameHasBeenSet ( ) const
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 60 of file RuleGroup.h.

◆ operator=()

RuleGroup& Aws::WAFV2::Model::RuleGroup::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RulesHasBeenSet()

bool Aws::WAFV2::Model::RuleGroup::RulesHasBeenSet ( ) const
inline

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.

Definition at line 313 of file RuleGroup.h.

◆ SetARN() [1/3]

void Aws::WAFV2::Model::RuleGroup::SetARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 235 of file RuleGroup.h.

◆ SetARN() [2/3]

void Aws::WAFV2::Model::RuleGroup::SetARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 230 of file RuleGroup.h.

◆ SetARN() [3/3]

void Aws::WAFV2::Model::RuleGroup::SetARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 240 of file RuleGroup.h.

◆ SetAvailableLabels() [1/2]

void Aws::WAFV2::Model::RuleGroup::SetAvailableLabels ( Aws::Vector< LabelSummary > &&  value)
inline

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

Definition at line 749 of file RuleGroup.h.

◆ SetAvailableLabels() [2/2]

void Aws::WAFV2::Model::RuleGroup::SetAvailableLabels ( const Aws::Vector< LabelSummary > &  value)
inline

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

Definition at line 742 of file RuleGroup.h.

◆ SetCapacity()

void Aws::WAFV2::Model::RuleGroup::SetCapacity ( long long  value)
inline

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, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

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.

Definition at line 199 of file RuleGroup.h.

◆ SetConsumedLabels() [1/2]

void Aws::WAFV2::Model::RuleGroup::SetConsumedLabels ( Aws::Vector< LabelSummary > &&  value)
inline

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.

Definition at line 806 of file RuleGroup.h.

◆ SetConsumedLabels() [2/2]

void Aws::WAFV2::Model::RuleGroup::SetConsumedLabels ( const Aws::Vector< LabelSummary > &  value)
inline

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.

Definition at line 799 of file RuleGroup.h.

◆ SetCustomResponseBodies() [1/2]

void Aws::WAFV2::Model::RuleGroup::SetCustomResponseBodies ( Aws::Map< Aws::String, CustomResponseBody > &&  value)
inline

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 AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 576 of file RuleGroup.h.

◆ SetCustomResponseBodies() [2/2]

void Aws::WAFV2::Model::RuleGroup::SetCustomResponseBodies ( const Aws::Map< Aws::String, CustomResponseBody > &  value)
inline

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 AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 558 of file RuleGroup.h.

◆ SetDescription() [1/3]

void Aws::WAFV2::Model::RuleGroup::SetDescription ( Aws::String &&  value)
inline

A description of the rule group that helps with identification.

Definition at line 276 of file RuleGroup.h.

◆ SetDescription() [2/3]

void Aws::WAFV2::Model::RuleGroup::SetDescription ( const Aws::String value)
inline

A description of the rule group that helps with identification.

Definition at line 271 of file RuleGroup.h.

◆ SetDescription() [3/3]

void Aws::WAFV2::Model::RuleGroup::SetDescription ( const char *  value)
inline

A description of the rule group that helps with identification.

Definition at line 281 of file RuleGroup.h.

◆ SetId() [1/3]

void Aws::WAFV2::Model::RuleGroup::SetId ( Aws::String &&  value)
inline

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.

Definition at line 125 of file RuleGroup.h.

◆ SetId() [2/3]

void Aws::WAFV2::Model::RuleGroup::SetId ( const Aws::String value)
inline

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.

Definition at line 118 of file RuleGroup.h.

◆ SetId() [3/3]

void Aws::WAFV2::Model::RuleGroup::SetId ( const char *  value)
inline

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.

Definition at line 132 of file RuleGroup.h.

◆ SetLabelNamespace() [1/3]

void Aws::WAFV2::Model::RuleGroup::SetLabelNamespace ( Aws::String &&  value)
inline

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, AWS 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>

Definition at line 451 of file RuleGroup.h.

◆ SetLabelNamespace() [2/3]

void Aws::WAFV2::Model::RuleGroup::SetLabelNamespace ( const Aws::String value)
inline

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, AWS 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>

Definition at line 438 of file RuleGroup.h.

◆ SetLabelNamespace() [3/3]

void Aws::WAFV2::Model::RuleGroup::SetLabelNamespace ( const char *  value)
inline

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, AWS 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>

Definition at line 464 of file RuleGroup.h.

◆ SetName() [1/3]

void Aws::WAFV2::Model::RuleGroup::SetName ( Aws::String &&  value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 72 of file RuleGroup.h.

◆ SetName() [2/3]

void Aws::WAFV2::Model::RuleGroup::SetName ( const Aws::String value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 66 of file RuleGroup.h.

◆ SetName() [3/3]

void Aws::WAFV2::Model::RuleGroup::SetName ( const char *  value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 78 of file RuleGroup.h.

◆ SetRules() [1/2]

void Aws::WAFV2::Model::RuleGroup::SetRules ( Aws::Vector< Rule > &&  value)
inline

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.

Definition at line 329 of file RuleGroup.h.

◆ SetRules() [2/2]

void Aws::WAFV2::Model::RuleGroup::SetRules ( const Aws::Vector< Rule > &  value)
inline

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.

Definition at line 321 of file RuleGroup.h.

◆ SetVisibilityConfig() [1/2]

void Aws::WAFV2::Model::RuleGroup::SetVisibilityConfig ( const VisibilityConfig value)
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 380 of file RuleGroup.h.

◆ SetVisibilityConfig() [2/2]

void Aws::WAFV2::Model::RuleGroup::SetVisibilityConfig ( VisibilityConfig &&  value)
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 386 of file RuleGroup.h.

◆ VisibilityConfigHasBeenSet()

bool Aws::WAFV2::Model::RuleGroup::VisibilityConfigHasBeenSet ( ) const
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 374 of file RuleGroup.h.

◆ WithARN() [1/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 250 of file RuleGroup.h.

◆ WithARN() [2/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 245 of file RuleGroup.h.

◆ WithARN() [3/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 255 of file RuleGroup.h.

◆ WithAvailableLabels() [1/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithAvailableLabels ( Aws::Vector< LabelSummary > &&  value)
inline

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

Definition at line 763 of file RuleGroup.h.

◆ WithAvailableLabels() [2/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithAvailableLabels ( const Aws::Vector< LabelSummary > &  value)
inline

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

Definition at line 756 of file RuleGroup.h.

◆ WithCapacity()

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithCapacity ( long long  value)
inline

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, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

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.

Definition at line 214 of file RuleGroup.h.

◆ WithConsumedLabels() [1/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithConsumedLabels ( Aws::Vector< LabelSummary > &&  value)
inline

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.

Definition at line 820 of file RuleGroup.h.

◆ WithConsumedLabels() [2/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithConsumedLabels ( const Aws::Vector< LabelSummary > &  value)
inline

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.

Definition at line 813 of file RuleGroup.h.

◆ WithCustomResponseBodies() [1/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithCustomResponseBodies ( Aws::Map< Aws::String, CustomResponseBody > &&  value)
inline

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 AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 612 of file RuleGroup.h.

◆ WithCustomResponseBodies() [2/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithCustomResponseBodies ( const Aws::Map< Aws::String, CustomResponseBody > &  value)
inline

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 AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 594 of file RuleGroup.h.

◆ WithDescription() [1/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithDescription ( Aws::String &&  value)
inline

A description of the rule group that helps with identification.

Definition at line 291 of file RuleGroup.h.

◆ WithDescription() [2/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithDescription ( const Aws::String value)
inline

A description of the rule group that helps with identification.

Definition at line 286 of file RuleGroup.h.

◆ WithDescription() [3/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithDescription ( const char *  value)
inline

A description of the rule group that helps with identification.

Definition at line 296 of file RuleGroup.h.

◆ WithId() [1/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithId ( Aws::String &&  value)
inline

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.

Definition at line 146 of file RuleGroup.h.

◆ WithId() [2/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithId ( const Aws::String value)
inline

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.

Definition at line 139 of file RuleGroup.h.

◆ WithId() [3/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithId ( const char *  value)
inline

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.

Definition at line 153 of file RuleGroup.h.

◆ WithLabelNamespace() [1/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithLabelNamespace ( Aws::String &&  value)
inline

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, AWS 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>

Definition at line 490 of file RuleGroup.h.

◆ WithLabelNamespace() [2/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithLabelNamespace ( const Aws::String value)
inline

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, AWS 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>

Definition at line 477 of file RuleGroup.h.

◆ WithLabelNamespace() [3/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithLabelNamespace ( const char *  value)
inline

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, AWS 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>

Definition at line 503 of file RuleGroup.h.

◆ WithName() [1/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithName ( Aws::String &&  value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 90 of file RuleGroup.h.

◆ WithName() [2/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithName ( const Aws::String value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 84 of file RuleGroup.h.

◆ WithName() [3/3]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithName ( const char *  value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 96 of file RuleGroup.h.

◆ WithRules() [1/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithRules ( Aws::Vector< Rule > &&  value)
inline

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.

Definition at line 345 of file RuleGroup.h.

◆ WithRules() [2/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithRules ( const Aws::Vector< Rule > &  value)
inline

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.

Definition at line 337 of file RuleGroup.h.

◆ WithVisibilityConfig() [1/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithVisibilityConfig ( const VisibilityConfig value)
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 392 of file RuleGroup.h.

◆ WithVisibilityConfig() [2/2]

RuleGroup& Aws::WAFV2::Model::RuleGroup::WithVisibilityConfig ( VisibilityConfig &&  value)
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 398 of file RuleGroup.h.


The documentation for this class was generated from the following file: