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

#include <Predicate.h>

Public Member Functions

 Predicate ()
 
 Predicate (Aws::Utils::Json::JsonView jsonValue)
 
Predicateoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetNegated () const
 
bool NegatedHasBeenSet () const
 
void SetNegated (bool value)
 
PredicateWithNegated (bool value)
 
const PredicateTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const PredicateType &value)
 
void SetType (PredicateType &&value)
 
PredicateWithType (const PredicateType &value)
 
PredicateWithType (PredicateType &&value)
 
const Aws::StringGetDataId () const
 
bool DataIdHasBeenSet () const
 
void SetDataId (const Aws::String &value)
 
void SetDataId (Aws::String &&value)
 
void SetDataId (const char *value)
 
PredicateWithDataId (const Aws::String &value)
 
PredicateWithDataId (Aws::String &&value)
 
PredicateWithDataId (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.

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.

See Also:

AWS API Reference

Definition at line 45 of file Predicate.h.

Constructor & Destructor Documentation

◆ Predicate() [1/2]

Aws::WAF::Model::Predicate::Predicate ( )

◆ Predicate() [2/2]

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

Member Function Documentation

◆ DataIdHasBeenSet()

bool Aws::WAF::Model::Predicate::DataIdHasBeenSet ( ) const
inline

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

Definition at line 172 of file Predicate.h.

◆ GetDataId()

const Aws::String& Aws::WAF::Model::Predicate::GetDataId ( ) const
inline

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

Definition at line 165 of file Predicate.h.

◆ GetNegated()

bool Aws::WAF::Model::Predicate::GetNegated ( ) const
inline

Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

Definition at line 69 of file Predicate.h.

◆ GetType()

const PredicateType& Aws::WAF::Model::Predicate::GetType ( ) const
inline

The type of predicate in a Rule, such as ByteMatch or IPSet.

Definition at line 127 of file Predicate.h.

◆ Jsonize()

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

◆ NegatedHasBeenSet()

bool Aws::WAF::Model::Predicate::NegatedHasBeenSet ( ) const
inline

Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

Definition at line 86 of file Predicate.h.

◆ operator=()

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

◆ SetDataId() [1/3]

void Aws::WAF::Model::Predicate::SetDataId ( Aws::String &&  value)
inline

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

Definition at line 186 of file Predicate.h.

◆ SetDataId() [2/3]

void Aws::WAF::Model::Predicate::SetDataId ( const Aws::String value)
inline

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

Definition at line 179 of file Predicate.h.

◆ SetDataId() [3/3]

void Aws::WAF::Model::Predicate::SetDataId ( const char *  value)
inline

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

Definition at line 193 of file Predicate.h.

◆ SetNegated()

void Aws::WAF::Model::Predicate::SetNegated ( bool  value)
inline

Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

Definition at line 103 of file Predicate.h.

◆ SetType() [1/2]

void Aws::WAF::Model::Predicate::SetType ( const PredicateType value)
inline

The type of predicate in a Rule, such as ByteMatch or IPSet.

Definition at line 139 of file Predicate.h.

◆ SetType() [2/2]

void Aws::WAF::Model::Predicate::SetType ( PredicateType &&  value)
inline

The type of predicate in a Rule, such as ByteMatch or IPSet.

Definition at line 145 of file Predicate.h.

◆ TypeHasBeenSet()

bool Aws::WAF::Model::Predicate::TypeHasBeenSet ( ) const
inline

The type of predicate in a Rule, such as ByteMatch or IPSet.

Definition at line 133 of file Predicate.h.

◆ WithDataId() [1/3]

Predicate& Aws::WAF::Model::Predicate::WithDataId ( Aws::String &&  value)
inline

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

Definition at line 207 of file Predicate.h.

◆ WithDataId() [2/3]

Predicate& Aws::WAF::Model::Predicate::WithDataId ( const Aws::String value)
inline

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

Definition at line 200 of file Predicate.h.

◆ WithDataId() [3/3]

Predicate& Aws::WAF::Model::Predicate::WithDataId ( const char *  value)
inline

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

Definition at line 214 of file Predicate.h.

◆ WithNegated()

Predicate& Aws::WAF::Model::Predicate::WithNegated ( bool  value)
inline

Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

Definition at line 120 of file Predicate.h.

◆ WithType() [1/2]

Predicate& Aws::WAF::Model::Predicate::WithType ( const PredicateType value)
inline

The type of predicate in a Rule, such as ByteMatch or IPSet.

Definition at line 151 of file Predicate.h.

◆ WithType() [2/2]

Predicate& Aws::WAF::Model::Predicate::WithType ( PredicateType &&  value)
inline

The type of predicate in a Rule, such as ByteMatch or IPSet.

Definition at line 157 of file Predicate.h.


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