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

#include <ByteMatchSet.h>

Public Member Functions

 ByteMatchSet ()
 
 ByteMatchSet (Aws::Utils::Json::JsonView jsonValue)
 
ByteMatchSetoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetByteMatchSetId () const
 
bool ByteMatchSetIdHasBeenSet () const
 
void SetByteMatchSetId (const Aws::String &value)
 
void SetByteMatchSetId (Aws::String &&value)
 
void SetByteMatchSetId (const char *value)
 
ByteMatchSetWithByteMatchSetId (const Aws::String &value)
 
ByteMatchSetWithByteMatchSetId (Aws::String &&value)
 
ByteMatchSetWithByteMatchSetId (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)
 
ByteMatchSetWithName (const Aws::String &value)
 
ByteMatchSetWithName (Aws::String &&value)
 
ByteMatchSetWithName (const char *value)
 
const Aws::Vector< ByteMatchTuple > & GetByteMatchTuples () const
 
bool ByteMatchTuplesHasBeenSet () const
 
void SetByteMatchTuples (const Aws::Vector< ByteMatchTuple > &value)
 
void SetByteMatchTuples (Aws::Vector< ByteMatchTuple > &&value)
 
ByteMatchSetWithByteMatchTuples (const Aws::Vector< ByteMatchTuple > &value)
 
ByteMatchSetWithByteMatchTuples (Aws::Vector< ByteMatchTuple > &&value)
 
ByteMatchSetAddByteMatchTuples (const ByteMatchTuple &value)
 
ByteMatchSetAddByteMatchTuples (ByteMatchTuple &&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.

In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you specified when you updated the ByteMatchSet.

A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

See Also:

AWS API Reference

Definition at line 50 of file ByteMatchSet.h.

Constructor & Destructor Documentation

◆ ByteMatchSet() [1/2]

Aws::WAF::Model::ByteMatchSet::ByteMatchSet ( )

◆ ByteMatchSet() [2/2]

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

Member Function Documentation

◆ AddByteMatchTuples() [1/2]

ByteMatchSet& Aws::WAF::Model::ByteMatchSet::AddByteMatchTuples ( ByteMatchTuple &&  value)
inline

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

Definition at line 259 of file ByteMatchSet.h.

◆ AddByteMatchTuples() [2/2]

ByteMatchSet& Aws::WAF::Model::ByteMatchSet::AddByteMatchTuples ( const ByteMatchTuple value)
inline

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

Definition at line 252 of file ByteMatchSet.h.

◆ ByteMatchSetIdHasBeenSet()

bool Aws::WAF::Model::ByteMatchSet::ByteMatchSetIdHasBeenSet ( ) const
inline

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

Definition at line 81 of file ByteMatchSet.h.

◆ ByteMatchTuplesHasBeenSet()

bool Aws::WAF::Model::ByteMatchSet::ByteMatchTuplesHasBeenSet ( ) const
inline

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

Definition at line 217 of file ByteMatchSet.h.

◆ GetByteMatchSetId()

const Aws::String& Aws::WAF::Model::ByteMatchSet::GetByteMatchSetId ( ) const
inline

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

Definition at line 69 of file ByteMatchSet.h.

◆ GetByteMatchTuples()

const Aws::Vector<ByteMatchTuple>& Aws::WAF::Model::ByteMatchSet::GetByteMatchTuples ( ) const
inline

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

Definition at line 210 of file ByteMatchSet.h.

◆ GetName()

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

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

Definition at line 160 of file ByteMatchSet.h.

◆ Jsonize()

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

◆ NameHasBeenSet()

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

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

Definition at line 166 of file ByteMatchSet.h.

◆ operator=()

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

◆ SetByteMatchSetId() [1/3]

void Aws::WAF::Model::ByteMatchSet::SetByteMatchSetId ( Aws::String &&  value)
inline

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

Definition at line 105 of file ByteMatchSet.h.

◆ SetByteMatchSetId() [2/3]

void Aws::WAF::Model::ByteMatchSet::SetByteMatchSetId ( const Aws::String value)
inline

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

Definition at line 93 of file ByteMatchSet.h.

◆ SetByteMatchSetId() [3/3]

void Aws::WAF::Model::ByteMatchSet::SetByteMatchSetId ( const char *  value)
inline

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

Definition at line 117 of file ByteMatchSet.h.

◆ SetByteMatchTuples() [1/2]

void Aws::WAF::Model::ByteMatchSet::SetByteMatchTuples ( Aws::Vector< ByteMatchTuple > &&  value)
inline

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

Definition at line 231 of file ByteMatchSet.h.

◆ SetByteMatchTuples() [2/2]

void Aws::WAF::Model::ByteMatchSet::SetByteMatchTuples ( const Aws::Vector< ByteMatchTuple > &  value)
inline

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

Definition at line 224 of file ByteMatchSet.h.

◆ SetName() [1/3]

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

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

Definition at line 178 of file ByteMatchSet.h.

◆ SetName() [2/3]

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

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

Definition at line 172 of file ByteMatchSet.h.

◆ SetName() [3/3]

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

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

Definition at line 184 of file ByteMatchSet.h.

◆ WithByteMatchSetId() [1/3]

ByteMatchSet& Aws::WAF::Model::ByteMatchSet::WithByteMatchSetId ( Aws::String &&  value)
inline

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

Definition at line 141 of file ByteMatchSet.h.

◆ WithByteMatchSetId() [2/3]

ByteMatchSet& Aws::WAF::Model::ByteMatchSet::WithByteMatchSetId ( const Aws::String value)
inline

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

Definition at line 129 of file ByteMatchSet.h.

◆ WithByteMatchSetId() [3/3]

ByteMatchSet& Aws::WAF::Model::ByteMatchSet::WithByteMatchSetId ( const char *  value)
inline

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

Definition at line 153 of file ByteMatchSet.h.

◆ WithByteMatchTuples() [1/2]

ByteMatchSet& Aws::WAF::Model::ByteMatchSet::WithByteMatchTuples ( Aws::Vector< ByteMatchTuple > &&  value)
inline

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

Definition at line 245 of file ByteMatchSet.h.

◆ WithByteMatchTuples() [2/2]

ByteMatchSet& Aws::WAF::Model::ByteMatchSet::WithByteMatchTuples ( const Aws::Vector< ByteMatchTuple > &  value)
inline

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

Definition at line 238 of file ByteMatchSet.h.

◆ WithName() [1/3]

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

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

Definition at line 196 of file ByteMatchSet.h.

◆ WithName() [2/3]

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

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

Definition at line 190 of file ByteMatchSet.h.

◆ WithName() [3/3]

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

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

Definition at line 202 of file ByteMatchSet.h.


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