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

#include <ForwardedIPConfig.h>

Public Member Functions

 ForwardedIPConfig ()
 
 ForwardedIPConfig (Aws::Utils::Json::JsonView jsonValue)
 
ForwardedIPConfigoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetHeaderName () const
 
bool HeaderNameHasBeenSet () const
 
void SetHeaderName (const Aws::String &value)
 
void SetHeaderName (Aws::String &&value)
 
void SetHeaderName (const char *value)
 
ForwardedIPConfigWithHeaderName (const Aws::String &value)
 
ForwardedIPConfigWithHeaderName (Aws::String &&value)
 
ForwardedIPConfigWithHeaderName (const char *value)
 
const FallbackBehaviorGetFallbackBehavior () const
 
bool FallbackBehaviorHasBeenSet () const
 
void SetFallbackBehavior (const FallbackBehavior &value)
 
void SetFallbackBehavior (FallbackBehavior &&value)
 
ForwardedIPConfigWithFallbackBehavior (const FallbackBehavior &value)
 
ForwardedIPConfigWithFallbackBehavior (FallbackBehavior &&value)
 

Detailed Description

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.

This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

WAF only evaluates the first IP address found in the specified HTTP header.

See Also:

AWS API Reference

Definition at line 40 of file ForwardedIPConfig.h.

Constructor & Destructor Documentation

◆ ForwardedIPConfig() [1/2]

Aws::WAFV2::Model::ForwardedIPConfig::ForwardedIPConfig ( )

◆ ForwardedIPConfig() [2/2]

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

Member Function Documentation

◆ FallbackBehaviorHasBeenSet()

bool Aws::WAFV2::Model::ForwardedIPConfig::FallbackBehaviorHasBeenSet ( ) const
inline

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

You can specify the following fallback behaviors:

  • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

  • NO_MATCH - Treat the web request as not matching the rule statement.

Definition at line 136 of file ForwardedIPConfig.h.

◆ GetFallbackBehavior()

const FallbackBehavior& Aws::WAFV2::Model::ForwardedIPConfig::GetFallbackBehavior ( ) const
inline

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

You can specify the following fallback behaviors:

  • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

  • NO_MATCH - Treat the web request as not matching the rule statement.

Definition at line 124 of file ForwardedIPConfig.h.

◆ GetHeaderName()

const Aws::String& Aws::WAFV2::Model::ForwardedIPConfig::GetHeaderName ( ) const
inline

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

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 55 of file ForwardedIPConfig.h.

◆ HeaderNameHasBeenSet()

bool Aws::WAFV2::Model::ForwardedIPConfig::HeaderNameHasBeenSet ( ) const
inline

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

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 63 of file ForwardedIPConfig.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetFallbackBehavior() [1/2]

void Aws::WAFV2::Model::ForwardedIPConfig::SetFallbackBehavior ( const FallbackBehavior value)
inline

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

You can specify the following fallback behaviors:

  • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

  • NO_MATCH - Treat the web request as not matching the rule statement.

Definition at line 148 of file ForwardedIPConfig.h.

◆ SetFallbackBehavior() [2/2]

void Aws::WAFV2::Model::ForwardedIPConfig::SetFallbackBehavior ( FallbackBehavior &&  value)
inline

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

You can specify the following fallback behaviors:

  • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

  • NO_MATCH - Treat the web request as not matching the rule statement.

Definition at line 160 of file ForwardedIPConfig.h.

◆ SetHeaderName() [1/3]

void Aws::WAFV2::Model::ForwardedIPConfig::SetHeaderName ( Aws::String &&  value)
inline

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

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 79 of file ForwardedIPConfig.h.

◆ SetHeaderName() [2/3]

void Aws::WAFV2::Model::ForwardedIPConfig::SetHeaderName ( const Aws::String value)
inline

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

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 71 of file ForwardedIPConfig.h.

◆ SetHeaderName() [3/3]

void Aws::WAFV2::Model::ForwardedIPConfig::SetHeaderName ( const char *  value)
inline

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

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 87 of file ForwardedIPConfig.h.

◆ WithFallbackBehavior() [1/2]

ForwardedIPConfig& Aws::WAFV2::Model::ForwardedIPConfig::WithFallbackBehavior ( const FallbackBehavior value)
inline

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

You can specify the following fallback behaviors:

  • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

  • NO_MATCH - Treat the web request as not matching the rule statement.

Definition at line 172 of file ForwardedIPConfig.h.

◆ WithFallbackBehavior() [2/2]

ForwardedIPConfig& Aws::WAFV2::Model::ForwardedIPConfig::WithFallbackBehavior ( FallbackBehavior &&  value)
inline

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

You can specify the following fallback behaviors:

  • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

  • NO_MATCH - Treat the web request as not matching the rule statement.

Definition at line 184 of file ForwardedIPConfig.h.

◆ WithHeaderName() [1/3]

ForwardedIPConfig& Aws::WAFV2::Model::ForwardedIPConfig::WithHeaderName ( Aws::String &&  value)
inline

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

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 103 of file ForwardedIPConfig.h.

◆ WithHeaderName() [2/3]

ForwardedIPConfig& Aws::WAFV2::Model::ForwardedIPConfig::WithHeaderName ( const Aws::String value)
inline

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

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 95 of file ForwardedIPConfig.h.

◆ WithHeaderName() [3/3]

ForwardedIPConfig& Aws::WAFV2::Model::ForwardedIPConfig::WithHeaderName ( const char *  value)
inline

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

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 111 of file ForwardedIPConfig.h.


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