AWS SDK for C++  1.9.44
AWS SDK for C++
Public Member Functions | List of all members
Aws::WAF::Model::Rule Class Reference

#include <Rule.h>

Public Member Functions

 Rule ()
 
 Rule (Aws::Utils::Json::JsonView jsonValue)
 
Ruleoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetRuleId () const
 
bool RuleIdHasBeenSet () const
 
void SetRuleId (const Aws::String &value)
 
void SetRuleId (Aws::String &&value)
 
void SetRuleId (const char *value)
 
RuleWithRuleId (const Aws::String &value)
 
RuleWithRuleId (Aws::String &&value)
 
RuleWithRuleId (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)
 
RuleWithName (const Aws::String &value)
 
RuleWithName (Aws::String &&value)
 
RuleWithName (const char *value)
 
const Aws::StringGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const Aws::String &value)
 
void SetMetricName (Aws::String &&value)
 
void SetMetricName (const char *value)
 
RuleWithMetricName (const Aws::String &value)
 
RuleWithMetricName (Aws::String &&value)
 
RuleWithMetricName (const char *value)
 
const Aws::Vector< Predicate > & GetPredicates () const
 
bool PredicatesHasBeenSet () const
 
void SetPredicates (const Aws::Vector< Predicate > &value)
 
void SetPredicates (Aws::Vector< Predicate > &&value)
 
RuleWithPredicates (const Aws::Vector< Predicate > &value)
 
RuleWithPredicates (Aws::Vector< Predicate > &&value)
 
RuleAddPredicates (const Predicate &value)
 
RuleAddPredicates (Predicate &&value)
 

Detailed Description

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:

To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot.

See Also:

AWS API Reference

Definition at line 51 of file Rule.h.

Constructor & Destructor Documentation

◆ Rule() [1/2]

Aws::WAF::Model::Rule::Rule ( )

◆ Rule() [2/2]

Aws::WAF::Model::Rule::Rule ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddPredicates() [1/2]

Rule& Aws::WAF::Model::Rule::AddPredicates ( const Predicate value)
inline

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Definition at line 325 of file Rule.h.

◆ AddPredicates() [2/2]

Rule& Aws::WAF::Model::Rule::AddPredicates ( Predicate &&  value)
inline

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Definition at line 333 of file Rule.h.

◆ GetMetricName()

const Aws::String& Aws::WAF::Model::Rule::GetMetricName ( ) const
inline

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

Definition at line 205 of file Rule.h.

◆ GetName()

const Aws::String& Aws::WAF::Model::Rule::GetName ( ) const
inline

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

Definition at line 153 of file Rule.h.

◆ GetPredicates()

const Aws::Vector<Predicate>& Aws::WAF::Model::Rule::GetPredicates ( ) const
inline

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Definition at line 277 of file Rule.h.

◆ GetRuleId()

const Aws::String& Aws::WAF::Model::Rule::GetRuleId ( ) const
inline

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Definition at line 69 of file Rule.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::WAF::Model::Rule::Jsonize ( ) const

◆ MetricNameHasBeenSet()

bool Aws::WAF::Model::Rule::MetricNameHasBeenSet ( ) const
inline

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

Definition at line 214 of file Rule.h.

◆ NameHasBeenSet()

bool Aws::WAF::Model::Rule::NameHasBeenSet ( ) const
inline

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

Definition at line 159 of file Rule.h.

◆ operator=()

Rule& Aws::WAF::Model::Rule::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PredicatesHasBeenSet()

bool Aws::WAF::Model::Rule::PredicatesHasBeenSet ( ) const
inline

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Definition at line 285 of file Rule.h.

◆ RuleIdHasBeenSet()

bool Aws::WAF::Model::Rule::RuleIdHasBeenSet ( ) const
inline

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Definition at line 80 of file Rule.h.

◆ SetMetricName() [1/3]

void Aws::WAF::Model::Rule::SetMetricName ( Aws::String &&  value)
inline

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

Definition at line 232 of file Rule.h.

◆ SetMetricName() [2/3]

void Aws::WAF::Model::Rule::SetMetricName ( const Aws::String value)
inline

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

Definition at line 223 of file Rule.h.

◆ SetMetricName() [3/3]

void Aws::WAF::Model::Rule::SetMetricName ( const char *  value)
inline

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

Definition at line 241 of file Rule.h.

◆ SetName() [1/3]

void Aws::WAF::Model::Rule::SetName ( Aws::String &&  value)
inline

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

Definition at line 171 of file Rule.h.

◆ SetName() [2/3]

void Aws::WAF::Model::Rule::SetName ( const Aws::String value)
inline

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

Definition at line 165 of file Rule.h.

◆ SetName() [3/3]

void Aws::WAF::Model::Rule::SetName ( const char *  value)
inline

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

Definition at line 177 of file Rule.h.

◆ SetPredicates() [1/2]

void Aws::WAF::Model::Rule::SetPredicates ( Aws::Vector< Predicate > &&  value)
inline

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Definition at line 301 of file Rule.h.

◆ SetPredicates() [2/2]

void Aws::WAF::Model::Rule::SetPredicates ( const Aws::Vector< Predicate > &  value)
inline

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Definition at line 293 of file Rule.h.

◆ SetRuleId() [1/3]

void Aws::WAF::Model::Rule::SetRuleId ( Aws::String &&  value)
inline

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Definition at line 102 of file Rule.h.

◆ SetRuleId() [2/3]

void Aws::WAF::Model::Rule::SetRuleId ( const Aws::String value)
inline

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Definition at line 91 of file Rule.h.

◆ SetRuleId() [3/3]

void Aws::WAF::Model::Rule::SetRuleId ( const char *  value)
inline

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Definition at line 113 of file Rule.h.

◆ WithMetricName() [1/3]

Rule& Aws::WAF::Model::Rule::WithMetricName ( Aws::String &&  value)
inline

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

Definition at line 259 of file Rule.h.

◆ WithMetricName() [2/3]

Rule& Aws::WAF::Model::Rule::WithMetricName ( const Aws::String value)
inline

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

Definition at line 250 of file Rule.h.

◆ WithMetricName() [3/3]

Rule& Aws::WAF::Model::Rule::WithMetricName ( const char *  value)
inline

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

Definition at line 268 of file Rule.h.

◆ WithName() [1/3]

Rule& Aws::WAF::Model::Rule::WithName ( Aws::String &&  value)
inline

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

Definition at line 189 of file Rule.h.

◆ WithName() [2/3]

Rule& Aws::WAF::Model::Rule::WithName ( const Aws::String value)
inline

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

Definition at line 183 of file Rule.h.

◆ WithName() [3/3]

Rule& Aws::WAF::Model::Rule::WithName ( const char *  value)
inline

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

Definition at line 195 of file Rule.h.

◆ WithPredicates() [1/2]

Rule& Aws::WAF::Model::Rule::WithPredicates ( Aws::Vector< Predicate > &&  value)
inline

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Definition at line 317 of file Rule.h.

◆ WithPredicates() [2/2]

Rule& Aws::WAF::Model::Rule::WithPredicates ( const Aws::Vector< Predicate > &  value)
inline

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Definition at line 309 of file Rule.h.

◆ WithRuleId() [1/3]

Rule& Aws::WAF::Model::Rule::WithRuleId ( Aws::String &&  value)
inline

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Definition at line 135 of file Rule.h.

◆ WithRuleId() [2/3]

Rule& Aws::WAF::Model::Rule::WithRuleId ( const Aws::String value)
inline

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Definition at line 124 of file Rule.h.

◆ WithRuleId() [3/3]

Rule& Aws::WAF::Model::Rule::WithRuleId ( const char *  value)
inline

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Definition at line 146 of file Rule.h.


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