AWS SDK for C++  1.9.160
AWS SDK for C++
Public Member Functions | List of all members
Aws::WAF::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::StringGetRuleGroupId () const
 
bool RuleGroupIdHasBeenSet () const
 
void SetRuleGroupId (const Aws::String &value)
 
void SetRuleGroupId (Aws::String &&value)
 
void SetRuleGroupId (const char *value)
 
RuleGroupWithRuleGroupId (const Aws::String &value)
 
RuleGroupWithRuleGroupId (Aws::String &&value)
 
RuleGroupWithRuleGroupId (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)
 
RuleGroupWithName (const Aws::String &value)
 
RuleGroupWithName (Aws::String &&value)
 
RuleGroupWithName (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)
 
RuleGroupWithMetricName (const Aws::String &value)
 
RuleGroupWithMetricName (Aws::String &&value)
 
RuleGroupWithMetricName (const char *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 collection of predefined rules that you can add to a web ACL.

Rule groups are subject to the following limits:

See Also:

AWS API Reference

Definition at line 43 of file RuleGroup.h.

Constructor & Destructor Documentation

◆ RuleGroup() [1/2]

Aws::WAF::Model::RuleGroup::RuleGroup ( )

◆ RuleGroup() [2/2]

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

Member Function Documentation

◆ GetMetricName()

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

A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.

Definition at line 206 of file RuleGroup.h.

◆ GetName()

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

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

Definition at line 153 of file RuleGroup.h.

◆ GetRuleGroupId()

const Aws::String& Aws::WAF::Model::RuleGroup::GetRuleGroupId ( ) const
inline

A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

Definition at line 62 of file RuleGroup.h.

◆ Jsonize()

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

◆ MetricNameHasBeenSet()

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

A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.

Definition at line 216 of file RuleGroup.h.

◆ NameHasBeenSet()

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

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

Definition at line 159 of file RuleGroup.h.

◆ operator=()

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

◆ RuleGroupIdHasBeenSet()

bool Aws::WAF::Model::RuleGroup::RuleGroupIdHasBeenSet ( ) const
inline

A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

Definition at line 74 of file RuleGroup.h.

◆ SetMetricName() [1/3]

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

A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.

Definition at line 236 of file RuleGroup.h.

◆ SetMetricName() [2/3]

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

A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.

Definition at line 226 of file RuleGroup.h.

◆ SetMetricName() [3/3]

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

A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.

Definition at line 246 of file RuleGroup.h.

◆ SetName() [1/3]

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

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

Definition at line 171 of file RuleGroup.h.

◆ SetName() [2/3]

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

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

Definition at line 165 of file RuleGroup.h.

◆ SetName() [3/3]

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

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

Definition at line 177 of file RuleGroup.h.

◆ SetRuleGroupId() [1/3]

void Aws::WAF::Model::RuleGroup::SetRuleGroupId ( Aws::String &&  value)
inline

A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

Definition at line 98 of file RuleGroup.h.

◆ SetRuleGroupId() [2/3]

void Aws::WAF::Model::RuleGroup::SetRuleGroupId ( const Aws::String value)
inline

A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

Definition at line 86 of file RuleGroup.h.

◆ SetRuleGroupId() [3/3]

void Aws::WAF::Model::RuleGroup::SetRuleGroupId ( const char *  value)
inline

A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

Definition at line 110 of file RuleGroup.h.

◆ WithMetricName() [1/3]

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

A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.

Definition at line 266 of file RuleGroup.h.

◆ WithMetricName() [2/3]

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

A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.

Definition at line 256 of file RuleGroup.h.

◆ WithMetricName() [3/3]

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

A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.

Definition at line 276 of file RuleGroup.h.

◆ WithName() [1/3]

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

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

Definition at line 189 of file RuleGroup.h.

◆ WithName() [2/3]

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

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

Definition at line 183 of file RuleGroup.h.

◆ WithName() [3/3]

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

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

Definition at line 195 of file RuleGroup.h.

◆ WithRuleGroupId() [1/3]

RuleGroup& Aws::WAF::Model::RuleGroup::WithRuleGroupId ( Aws::String &&  value)
inline

A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

Definition at line 134 of file RuleGroup.h.

◆ WithRuleGroupId() [2/3]

RuleGroup& Aws::WAF::Model::RuleGroup::WithRuleGroupId ( const Aws::String value)
inline

A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

Definition at line 122 of file RuleGroup.h.

◆ WithRuleGroupId() [3/3]

RuleGroup& Aws::WAF::Model::RuleGroup::WithRuleGroupId ( const char *  value)
inline

A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

Definition at line 146 of file RuleGroup.h.


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