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

#include <ManagedRuleGroupStatement.h>

Public Member Functions

 ManagedRuleGroupStatement ()
 
 ManagedRuleGroupStatement (Aws::Utils::Json::JsonView jsonValue)
 
ManagedRuleGroupStatementoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetVendorName () const
 
bool VendorNameHasBeenSet () const
 
void SetVendorName (const Aws::String &value)
 
void SetVendorName (Aws::String &&value)
 
void SetVendorName (const char *value)
 
ManagedRuleGroupStatementWithVendorName (const Aws::String &value)
 
ManagedRuleGroupStatementWithVendorName (Aws::String &&value)
 
ManagedRuleGroupStatementWithVendorName (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
ManagedRuleGroupStatementWithName (const Aws::String &value)
 
ManagedRuleGroupStatementWithName (Aws::String &&value)
 
ManagedRuleGroupStatementWithName (const char *value)
 
const Aws::StringGetVersion () const
 
bool VersionHasBeenSet () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
ManagedRuleGroupStatementWithVersion (const Aws::String &value)
 
ManagedRuleGroupStatementWithVersion (Aws::String &&value)
 
ManagedRuleGroupStatementWithVersion (const char *value)
 
const Aws::Vector< ExcludedRule > & GetExcludedRules () const
 
bool ExcludedRulesHasBeenSet () const
 
void SetExcludedRules (const Aws::Vector< ExcludedRule > &value)
 
void SetExcludedRules (Aws::Vector< ExcludedRule > &&value)
 
ManagedRuleGroupStatementWithExcludedRules (const Aws::Vector< ExcludedRule > &value)
 
ManagedRuleGroupStatementWithExcludedRules (Aws::Vector< ExcludedRule > &&value)
 
ManagedRuleGroupStatementAddExcludedRules (const ExcludedRule &value)
 
ManagedRuleGroupStatementAddExcludedRules (ExcludedRule &&value)
 
const StatementGetScopeDownStatement () const
 
bool ScopeDownStatementHasBeenSet () const
 
void SetScopeDownStatement (const Statement &value)
 
void SetScopeDownStatement (Statement &&value)
 
ManagedRuleGroupStatementWithScopeDownStatement (const Statement &value)
 
ManagedRuleGroupStatementWithScopeDownStatement (Statement &&value)
 

Detailed Description

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

See Also:

AWS API Reference

Definition at line 41 of file ManagedRuleGroupStatement.h.

Constructor & Destructor Documentation

◆ ManagedRuleGroupStatement() [1/2]

Aws::WAFV2::Model::ManagedRuleGroupStatement::ManagedRuleGroupStatement ( )

◆ ManagedRuleGroupStatement() [2/2]

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

Member Function Documentation

◆ AddExcludedRules() [1/2]

ManagedRuleGroupStatement& Aws::WAFV2::Model::ManagedRuleGroupStatement::AddExcludedRules ( const ExcludedRule value)
inline

The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.

Definition at line 274 of file ManagedRuleGroupStatement.h.

◆ AddExcludedRules() [2/2]

ManagedRuleGroupStatement& Aws::WAFV2::Model::ManagedRuleGroupStatement::AddExcludedRules ( ExcludedRule &&  value)
inline

The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.

Definition at line 283 of file ManagedRuleGroupStatement.h.

◆ ExcludedRulesHasBeenSet()

bool Aws::WAFV2::Model::ManagedRuleGroupStatement::ExcludedRulesHasBeenSet ( ) const
inline

The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.

Definition at line 229 of file ManagedRuleGroupStatement.h.

◆ GetExcludedRules()

const Aws::Vector<ExcludedRule>& Aws::WAFV2::Model::ManagedRuleGroupStatement::GetExcludedRules ( ) const
inline

The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.

Definition at line 220 of file ManagedRuleGroupStatement.h.

◆ GetName()

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

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

Definition at line 103 of file ManagedRuleGroupStatement.h.

◆ GetScopeDownStatement()

const Statement& Aws::WAFV2::Model::ManagedRuleGroupStatement::GetScopeDownStatement ( ) const

An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

◆ GetVendorName()

const Aws::String& Aws::WAFV2::Model::ManagedRuleGroupStatement::GetVendorName ( ) const
inline

The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

Definition at line 54 of file ManagedRuleGroupStatement.h.

◆ GetVersion()

const Aws::String& Aws::WAFV2::Model::ManagedRuleGroupStatement::GetVersion ( ) const
inline

The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

Definition at line 154 of file ManagedRuleGroupStatement.h.

◆ Jsonize()

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

◆ NameHasBeenSet()

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

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

Definition at line 109 of file ManagedRuleGroupStatement.h.

◆ operator=()

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

◆ ScopeDownStatementHasBeenSet()

bool Aws::WAFV2::Model::ManagedRuleGroupStatement::ScopeDownStatementHasBeenSet ( ) const

An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

◆ SetExcludedRules() [1/2]

void Aws::WAFV2::Model::ManagedRuleGroupStatement::SetExcludedRules ( Aws::Vector< ExcludedRule > &&  value)
inline

The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.

Definition at line 247 of file ManagedRuleGroupStatement.h.

◆ SetExcludedRules() [2/2]

void Aws::WAFV2::Model::ManagedRuleGroupStatement::SetExcludedRules ( const Aws::Vector< ExcludedRule > &  value)
inline

The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.

Definition at line 238 of file ManagedRuleGroupStatement.h.

◆ SetName() [1/3]

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

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

Definition at line 121 of file ManagedRuleGroupStatement.h.

◆ SetName() [2/3]

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

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

Definition at line 115 of file ManagedRuleGroupStatement.h.

◆ SetName() [3/3]

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

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

Definition at line 127 of file ManagedRuleGroupStatement.h.

◆ SetScopeDownStatement() [1/2]

void Aws::WAFV2::Model::ManagedRuleGroupStatement::SetScopeDownStatement ( const Statement value)

An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

◆ SetScopeDownStatement() [2/2]

void Aws::WAFV2::Model::ManagedRuleGroupStatement::SetScopeDownStatement ( Statement &&  value)

An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

◆ SetVendorName() [1/3]

void Aws::WAFV2::Model::ManagedRuleGroupStatement::SetVendorName ( Aws::String &&  value)
inline

The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

Definition at line 72 of file ManagedRuleGroupStatement.h.

◆ SetVendorName() [2/3]

void Aws::WAFV2::Model::ManagedRuleGroupStatement::SetVendorName ( const Aws::String value)
inline

The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

Definition at line 66 of file ManagedRuleGroupStatement.h.

◆ SetVendorName() [3/3]

void Aws::WAFV2::Model::ManagedRuleGroupStatement::SetVendorName ( const char *  value)
inline

The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

Definition at line 78 of file ManagedRuleGroupStatement.h.

◆ SetVersion() [1/3]

void Aws::WAFV2::Model::ManagedRuleGroupStatement::SetVersion ( Aws::String &&  value)
inline

The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

Definition at line 178 of file ManagedRuleGroupStatement.h.

◆ SetVersion() [2/3]

void Aws::WAFV2::Model::ManagedRuleGroupStatement::SetVersion ( const Aws::String value)
inline

The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

Definition at line 170 of file ManagedRuleGroupStatement.h.

◆ SetVersion() [3/3]

void Aws::WAFV2::Model::ManagedRuleGroupStatement::SetVersion ( const char *  value)
inline

The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

Definition at line 186 of file ManagedRuleGroupStatement.h.

◆ VendorNameHasBeenSet()

bool Aws::WAFV2::Model::ManagedRuleGroupStatement::VendorNameHasBeenSet ( ) const
inline

The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

Definition at line 60 of file ManagedRuleGroupStatement.h.

◆ VersionHasBeenSet()

bool Aws::WAFV2::Model::ManagedRuleGroupStatement::VersionHasBeenSet ( ) const
inline

The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

Definition at line 162 of file ManagedRuleGroupStatement.h.

◆ WithExcludedRules() [1/2]

ManagedRuleGroupStatement& Aws::WAFV2::Model::ManagedRuleGroupStatement::WithExcludedRules ( Aws::Vector< ExcludedRule > &&  value)
inline

The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.

Definition at line 265 of file ManagedRuleGroupStatement.h.

◆ WithExcludedRules() [2/2]

ManagedRuleGroupStatement& Aws::WAFV2::Model::ManagedRuleGroupStatement::WithExcludedRules ( const Aws::Vector< ExcludedRule > &  value)
inline

The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.

Definition at line 256 of file ManagedRuleGroupStatement.h.

◆ WithName() [1/3]

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

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

Definition at line 139 of file ManagedRuleGroupStatement.h.

◆ WithName() [2/3]

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

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

Definition at line 133 of file ManagedRuleGroupStatement.h.

◆ WithName() [3/3]

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

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

Definition at line 145 of file ManagedRuleGroupStatement.h.

◆ WithScopeDownStatement() [1/2]

ManagedRuleGroupStatement& Aws::WAFV2::Model::ManagedRuleGroupStatement::WithScopeDownStatement ( const Statement value)

An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

◆ WithScopeDownStatement() [2/2]

ManagedRuleGroupStatement& Aws::WAFV2::Model::ManagedRuleGroupStatement::WithScopeDownStatement ( Statement &&  value)

An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

◆ WithVendorName() [1/3]

ManagedRuleGroupStatement& Aws::WAFV2::Model::ManagedRuleGroupStatement::WithVendorName ( Aws::String &&  value)
inline

The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

Definition at line 90 of file ManagedRuleGroupStatement.h.

◆ WithVendorName() [2/3]

ManagedRuleGroupStatement& Aws::WAFV2::Model::ManagedRuleGroupStatement::WithVendorName ( const Aws::String value)
inline

The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

Definition at line 84 of file ManagedRuleGroupStatement.h.

◆ WithVendorName() [3/3]

ManagedRuleGroupStatement& Aws::WAFV2::Model::ManagedRuleGroupStatement::WithVendorName ( const char *  value)
inline

The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

Definition at line 96 of file ManagedRuleGroupStatement.h.

◆ WithVersion() [1/3]

ManagedRuleGroupStatement& Aws::WAFV2::Model::ManagedRuleGroupStatement::WithVersion ( Aws::String &&  value)
inline

The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

Definition at line 202 of file ManagedRuleGroupStatement.h.

◆ WithVersion() [2/3]

ManagedRuleGroupStatement& Aws::WAFV2::Model::ManagedRuleGroupStatement::WithVersion ( const Aws::String value)
inline

The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

Definition at line 194 of file ManagedRuleGroupStatement.h.

◆ WithVersion() [3/3]

ManagedRuleGroupStatement& Aws::WAFV2::Model::ManagedRuleGroupStatement::WithVersion ( const char *  value)
inline

The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

Definition at line 210 of file ManagedRuleGroupStatement.h.


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