Class CfnWebACL.ForwardedIPConfigurationProperty

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
object
CfnWebACL.ForwardedIPConfigurationProperty
Inherited Members
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnWebACL.ForwardedIPConfigurationProperty : CfnWebACL.IForwardedIPConfigurationProperty
Syntax (vb)
Public Class CfnWebACL.ForwardedIPConfigurationProperty Implements CfnWebACL.IForwardedIPConfigurationProperty
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 for GeoMatchStatement , AsnMatchStatement , and RateBasedStatement . For IPSetReferenceStatement , use IPSetForwardedIPConfig instead.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-forwardedipconfiguration.html

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 forwardedIPConfigurationProperty = new ForwardedIPConfigurationProperty {
                 FallbackBehavior = "fallbackBehavior",
                 HeaderName = "headerName"
             };

Synopsis

Constructors

ForwardedIPConfigurationProperty()

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.

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.

Constructors

ForwardedIPConfigurationProperty()

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.

public ForwardedIPConfigurationProperty()
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 for GeoMatchStatement , AsnMatchStatement , and RateBasedStatement . For IPSetReferenceStatement , use IPSetForwardedIPConfig instead.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-forwardedipconfiguration.html

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 forwardedIPConfigurationProperty = new ForwardedIPConfigurationProperty {
                 FallbackBehavior = "fallbackBehavior",
                 HeaderName = "headerName"
             };

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

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:

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-forwardedipconfiguration.html#cfn-wafv2-webacl-forwardedipconfiguration-fallbackbehavior

    HeaderName

    The name of the HTTP header to use for the IP address.

    public string HeaderName { get; set; }
    Property Value

    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.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-forwardedipconfiguration.html#cfn-wafv2-webacl-forwardedipconfiguration-headername

    Implements