AWS SDK for C++  1.9.128
AWS SDK for C++
Public Member Functions | List of all members
Aws::WAFV2::Model::IPSetReferenceStatement Class Reference

#include <IPSetReferenceStatement.h>

Public Member Functions

 IPSetReferenceStatement ()
 
 IPSetReferenceStatement (Aws::Utils::Json::JsonView jsonValue)
 
IPSetReferenceStatementoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetARN () const
 
bool ARNHasBeenSet () const
 
void SetARN (const Aws::String &value)
 
void SetARN (Aws::String &&value)
 
void SetARN (const char *value)
 
IPSetReferenceStatementWithARN (const Aws::String &value)
 
IPSetReferenceStatementWithARN (Aws::String &&value)
 
IPSetReferenceStatementWithARN (const char *value)
 
const IPSetForwardedIPConfigGetIPSetForwardedIPConfig () const
 
bool IPSetForwardedIPConfigHasBeenSet () const
 
void SetIPSetForwardedIPConfig (const IPSetForwardedIPConfig &value)
 
void SetIPSetForwardedIPConfig (IPSetForwardedIPConfig &&value)
 
IPSetReferenceStatementWithIPSetForwardedIPConfig (const IPSetForwardedIPConfig &value)
 
IPSetReferenceStatementWithIPSetForwardedIPConfig (IPSetForwardedIPConfig &&value)
 

Detailed Description

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

See Also:

AWS API Reference

Definition at line 39 of file IPSetReferenceStatement.h.

Constructor & Destructor Documentation

◆ IPSetReferenceStatement() [1/2]

Aws::WAFV2::Model::IPSetReferenceStatement::IPSetReferenceStatement ( )

◆ IPSetReferenceStatement() [2/2]

Aws::WAFV2::Model::IPSetReferenceStatement::IPSetReferenceStatement ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ARNHasBeenSet()

bool Aws::WAFV2::Model::IPSetReferenceStatement::ARNHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the IPSet that this statement references.

Definition at line 58 of file IPSetReferenceStatement.h.

◆ GetARN()

const Aws::String& Aws::WAFV2::Model::IPSetReferenceStatement::GetARN ( ) const
inline

The Amazon Resource Name (ARN) of the IPSet that this statement references.

Definition at line 52 of file IPSetReferenceStatement.h.

◆ GetIPSetForwardedIPConfig()

const IPSetForwardedIPConfig& Aws::WAFV2::Model::IPSetReferenceStatement::GetIPSetForwardedIPConfig ( ) const
inline

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

Definition at line 104 of file IPSetReferenceStatement.h.

◆ IPSetForwardedIPConfigHasBeenSet()

bool Aws::WAFV2::Model::IPSetReferenceStatement::IPSetForwardedIPConfigHasBeenSet ( ) const
inline

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

Definition at line 113 of file IPSetReferenceStatement.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::WAFV2::Model::IPSetReferenceStatement::Jsonize ( ) const

◆ operator=()

IPSetReferenceStatement& Aws::WAFV2::Model::IPSetReferenceStatement::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetARN() [1/3]

void Aws::WAFV2::Model::IPSetReferenceStatement::SetARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the IPSet that this statement references.

Definition at line 70 of file IPSetReferenceStatement.h.

◆ SetARN() [2/3]

void Aws::WAFV2::Model::IPSetReferenceStatement::SetARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the IPSet that this statement references.

Definition at line 64 of file IPSetReferenceStatement.h.

◆ SetARN() [3/3]

void Aws::WAFV2::Model::IPSetReferenceStatement::SetARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the IPSet that this statement references.

Definition at line 76 of file IPSetReferenceStatement.h.

◆ SetIPSetForwardedIPConfig() [1/2]

void Aws::WAFV2::Model::IPSetReferenceStatement::SetIPSetForwardedIPConfig ( const IPSetForwardedIPConfig value)
inline

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

Definition at line 122 of file IPSetReferenceStatement.h.

◆ SetIPSetForwardedIPConfig() [2/2]

void Aws::WAFV2::Model::IPSetReferenceStatement::SetIPSetForwardedIPConfig ( IPSetForwardedIPConfig &&  value)
inline

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

Definition at line 131 of file IPSetReferenceStatement.h.

◆ WithARN() [1/3]

IPSetReferenceStatement& Aws::WAFV2::Model::IPSetReferenceStatement::WithARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the IPSet that this statement references.

Definition at line 88 of file IPSetReferenceStatement.h.

◆ WithARN() [2/3]

IPSetReferenceStatement& Aws::WAFV2::Model::IPSetReferenceStatement::WithARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the IPSet that this statement references.

Definition at line 82 of file IPSetReferenceStatement.h.

◆ WithARN() [3/3]

IPSetReferenceStatement& Aws::WAFV2::Model::IPSetReferenceStatement::WithARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the IPSet that this statement references.

Definition at line 94 of file IPSetReferenceStatement.h.

◆ WithIPSetForwardedIPConfig() [1/2]

IPSetReferenceStatement& Aws::WAFV2::Model::IPSetReferenceStatement::WithIPSetForwardedIPConfig ( const IPSetForwardedIPConfig value)
inline

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

Definition at line 140 of file IPSetReferenceStatement.h.

◆ WithIPSetForwardedIPConfig() [2/2]

IPSetReferenceStatement& Aws::WAFV2::Model::IPSetReferenceStatement::WithIPSetForwardedIPConfig ( IPSetForwardedIPConfig &&  value)
inline

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

Definition at line 149 of file IPSetReferenceStatement.h.


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