Class CfnWebACL.IPSetForwardedIPConfigurationProperty
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.
Inheritance
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class IPSetForwardedIPConfigurationProperty : Object, CfnWebACL.IIPSetForwardedIPConfigurationProperty
Syntax (vb)
Public Class IPSetForwardedIPConfigurationProperty
Inherits Object
Implements CfnWebACL.IIPSetForwardedIPConfigurationProperty
Remarks
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, AWS WAF doesn't apply the rule to the web request at all.
This configuration is used only for IPSetReferenceStatement
. For GeoMatchStatement
and RateBasedStatement
, use ForwardedIPConfig
instead.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WAFv2;
var iPSetForwardedIPConfigurationProperty = new Dictionary<string, string> {
{ "fallbackBehavior", "fallbackBehavior" },
{ "headerName", "headerName" },
{ "position", "position" }
};
Synopsis
Constructors
IPSetForwardedIPConfigurationProperty() |
Properties
FallbackBehavior | The match status to assign to the web request if the request doesn't have a valid IP address in the specified position. |
HeaderName | The name of the HTTP header to use for the IP address. |
Position | The position in the header to search for the IP address. |
Constructors
IPSetForwardedIPConfigurationProperty()
public IPSetForwardedIPConfigurationProperty()
Properties
FallbackBehavior
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
public string FallbackBehavior { get; set; }
Property Value
System.String
Remarks
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
HeaderName
The name of the HTTP header to use for the IP address.
public string HeaderName { get; set; }
Property Value
System.String
Remarks
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, AWS WAF doesn't apply the rule to the web request at all.
Position
The position in the header to search for the IP address.
public string Position { get; set; }
Property Value
System.String
Remarks
The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10
where the first IP address identifies the original client and the rest identify proxies that the request went through.
The options for this setting are the following: