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

#include <WebACL.h>

Public Member Functions

 WebACL ()
 
 WebACL (Aws::Utils::Json::JsonView jsonValue)
 
WebACLoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetWebACLId () const
 
bool WebACLIdHasBeenSet () const
 
void SetWebACLId (const Aws::String &value)
 
void SetWebACLId (Aws::String &&value)
 
void SetWebACLId (const char *value)
 
WebACLWithWebACLId (const Aws::String &value)
 
WebACLWithWebACLId (Aws::String &&value)
 
WebACLWithWebACLId (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)
 
WebACLWithName (const Aws::String &value)
 
WebACLWithName (Aws::String &&value)
 
WebACLWithName (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)
 
WebACLWithMetricName (const Aws::String &value)
 
WebACLWithMetricName (Aws::String &&value)
 
WebACLWithMetricName (const char *value)
 
const WafActionGetDefaultAction () const
 
bool DefaultActionHasBeenSet () const
 
void SetDefaultAction (const WafAction &value)
 
void SetDefaultAction (WafAction &&value)
 
WebACLWithDefaultAction (const WafAction &value)
 
WebACLWithDefaultAction (WafAction &&value)
 
const Aws::Vector< ActivatedRule > & GetRules () const
 
bool RulesHasBeenSet () const
 
void SetRules (const Aws::Vector< ActivatedRule > &value)
 
void SetRules (Aws::Vector< ActivatedRule > &&value)
 
WebACLWithRules (const Aws::Vector< ActivatedRule > &value)
 
WebACLWithRules (Aws::Vector< ActivatedRule > &&value)
 
WebACLAddRules (const ActivatedRule &value)
 
WebACLAddRules (ActivatedRule &&value)
 
const Aws::StringGetWebACLArn () const
 
bool WebACLArnHasBeenSet () const
 
void SetWebACLArn (const Aws::String &value)
 
void SetWebACLArn (Aws::String &&value)
 
void SetWebACLArn (const char *value)
 
WebACLWithWebACLArn (const Aws::String &value)
 
WebACLWithWebACLArn (Aws::String &&value)
 
WebACLWithWebACLArn (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.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.

See Also:

AWS API Reference

Definition at line 51 of file WebACL.h.

Constructor & Destructor Documentation

◆ WebACL() [1/2]

Aws::WAF::Model::WebACL::WebACL ( )

◆ WebACL() [2/2]

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

Member Function Documentation

◆ AddRules() [1/2]

WebACL& Aws::WAF::Model::WebACL::AddRules ( ActivatedRule &&  value)
inline

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Definition at line 352 of file WebACL.h.

◆ AddRules() [2/2]

WebACL& Aws::WAF::Model::WebACL::AddRules ( const ActivatedRule value)
inline

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Definition at line 345 of file WebACL.h.

◆ DefaultActionHasBeenSet()

bool Aws::WAF::Model::WebACL::DefaultActionHasBeenSet ( ) const
inline

The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

Definition at line 267 of file WebACL.h.

◆ GetDefaultAction()

const WafAction& Aws::WAF::Model::WebACL::GetDefaultAction ( ) const
inline

The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

Definition at line 260 of file WebACL.h.

◆ GetMetricName()

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

A friendly name or description for the metrics for this WebACL. 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 WebACL.

Definition at line 189 of file WebACL.h.

◆ GetName()

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

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

Definition at line 137 of file WebACL.h.

◆ GetRules()

const Aws::Vector<ActivatedRule>& Aws::WAF::Model::WebACL::GetRules ( ) const
inline

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Definition at line 303 of file WebACL.h.

◆ GetWebACLArn()

const Aws::String& Aws::WAF::Model::WebACL::GetWebACLArn ( ) const
inline

Tha Amazon Resource Name (ARN) of the web ACL.

Definition at line 358 of file WebACL.h.

◆ GetWebACLId()

const Aws::String& Aws::WAF::Model::WebACL::GetWebACLId ( ) const
inline

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

Definition at line 67 of file WebACL.h.

◆ Jsonize()

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

◆ MetricNameHasBeenSet()

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

A friendly name or description for the metrics for this WebACL. 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 WebACL.

Definition at line 198 of file WebACL.h.

◆ NameHasBeenSet()

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

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

Definition at line 143 of file WebACL.h.

◆ operator=()

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

◆ RulesHasBeenSet()

bool Aws::WAF::Model::WebACL::RulesHasBeenSet ( ) const
inline

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Definition at line 310 of file WebACL.h.

◆ SetDefaultAction() [1/2]

void Aws::WAF::Model::WebACL::SetDefaultAction ( const WafAction value)
inline

The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

Definition at line 274 of file WebACL.h.

◆ SetDefaultAction() [2/2]

void Aws::WAF::Model::WebACL::SetDefaultAction ( WafAction &&  value)
inline

The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

Definition at line 281 of file WebACL.h.

◆ SetMetricName() [1/3]

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

A friendly name or description for the metrics for this WebACL. 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 WebACL.

Definition at line 216 of file WebACL.h.

◆ SetMetricName() [2/3]

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

A friendly name or description for the metrics for this WebACL. 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 WebACL.

Definition at line 207 of file WebACL.h.

◆ SetMetricName() [3/3]

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

A friendly name or description for the metrics for this WebACL. 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 WebACL.

Definition at line 225 of file WebACL.h.

◆ SetName() [1/3]

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

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

Definition at line 155 of file WebACL.h.

◆ SetName() [2/3]

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

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

Definition at line 149 of file WebACL.h.

◆ SetName() [3/3]

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

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

Definition at line 161 of file WebACL.h.

◆ SetRules() [1/2]

void Aws::WAF::Model::WebACL::SetRules ( Aws::Vector< ActivatedRule > &&  value)
inline

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Definition at line 324 of file WebACL.h.

◆ SetRules() [2/2]

void Aws::WAF::Model::WebACL::SetRules ( const Aws::Vector< ActivatedRule > &  value)
inline

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Definition at line 317 of file WebACL.h.

◆ SetWebACLArn() [1/3]

void Aws::WAF::Model::WebACL::SetWebACLArn ( Aws::String &&  value)
inline

Tha Amazon Resource Name (ARN) of the web ACL.

Definition at line 373 of file WebACL.h.

◆ SetWebACLArn() [2/3]

void Aws::WAF::Model::WebACL::SetWebACLArn ( const Aws::String value)
inline

Tha Amazon Resource Name (ARN) of the web ACL.

Definition at line 368 of file WebACL.h.

◆ SetWebACLArn() [3/3]

void Aws::WAF::Model::WebACL::SetWebACLArn ( const char *  value)
inline

Tha Amazon Resource Name (ARN) of the web ACL.

Definition at line 378 of file WebACL.h.

◆ SetWebACLId() [1/3]

void Aws::WAF::Model::WebACL::SetWebACLId ( Aws::String &&  value)
inline

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

Definition at line 94 of file WebACL.h.

◆ SetWebACLId() [2/3]

void Aws::WAF::Model::WebACL::SetWebACLId ( const Aws::String value)
inline

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

Definition at line 85 of file WebACL.h.

◆ SetWebACLId() [3/3]

void Aws::WAF::Model::WebACL::SetWebACLId ( const char *  value)
inline

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

Definition at line 103 of file WebACL.h.

◆ WebACLArnHasBeenSet()

bool Aws::WAF::Model::WebACL::WebACLArnHasBeenSet ( ) const
inline

Tha Amazon Resource Name (ARN) of the web ACL.

Definition at line 363 of file WebACL.h.

◆ WebACLIdHasBeenSet()

bool Aws::WAF::Model::WebACL::WebACLIdHasBeenSet ( ) const
inline

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

Definition at line 76 of file WebACL.h.

◆ WithDefaultAction() [1/2]

WebACL& Aws::WAF::Model::WebACL::WithDefaultAction ( const WafAction value)
inline

The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

Definition at line 288 of file WebACL.h.

◆ WithDefaultAction() [2/2]

WebACL& Aws::WAF::Model::WebACL::WithDefaultAction ( WafAction &&  value)
inline

The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

Definition at line 295 of file WebACL.h.

◆ WithMetricName() [1/3]

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

A friendly name or description for the metrics for this WebACL. 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 WebACL.

Definition at line 243 of file WebACL.h.

◆ WithMetricName() [2/3]

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

A friendly name or description for the metrics for this WebACL. 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 WebACL.

Definition at line 234 of file WebACL.h.

◆ WithMetricName() [3/3]

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

A friendly name or description for the metrics for this WebACL. 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 WebACL.

Definition at line 252 of file WebACL.h.

◆ WithName() [1/3]

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

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

Definition at line 173 of file WebACL.h.

◆ WithName() [2/3]

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

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

Definition at line 167 of file WebACL.h.

◆ WithName() [3/3]

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

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

Definition at line 179 of file WebACL.h.

◆ WithRules() [1/2]

WebACL& Aws::WAF::Model::WebACL::WithRules ( Aws::Vector< ActivatedRule > &&  value)
inline

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Definition at line 338 of file WebACL.h.

◆ WithRules() [2/2]

WebACL& Aws::WAF::Model::WebACL::WithRules ( const Aws::Vector< ActivatedRule > &  value)
inline

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Definition at line 331 of file WebACL.h.

◆ WithWebACLArn() [1/3]

WebACL& Aws::WAF::Model::WebACL::WithWebACLArn ( Aws::String &&  value)
inline

Tha Amazon Resource Name (ARN) of the web ACL.

Definition at line 388 of file WebACL.h.

◆ WithWebACLArn() [2/3]

WebACL& Aws::WAF::Model::WebACL::WithWebACLArn ( const Aws::String value)
inline

Tha Amazon Resource Name (ARN) of the web ACL.

Definition at line 383 of file WebACL.h.

◆ WithWebACLArn() [3/3]

WebACL& Aws::WAF::Model::WebACL::WithWebACLArn ( const char *  value)
inline

Tha Amazon Resource Name (ARN) of the web ACL.

Definition at line 393 of file WebACL.h.

◆ WithWebACLId() [1/3]

WebACL& Aws::WAF::Model::WebACL::WithWebACLId ( Aws::String &&  value)
inline

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

Definition at line 121 of file WebACL.h.

◆ WithWebACLId() [2/3]

WebACL& Aws::WAF::Model::WebACL::WithWebACLId ( const Aws::String value)
inline

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

Definition at line 112 of file WebACL.h.

◆ WithWebACLId() [3/3]

WebACL& Aws::WAF::Model::WebACL::WithWebACLId ( const char *  value)
inline

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

Definition at line 130 of file WebACL.h.


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