Package software.amazon.awscdk.services.wafv2

Interface CfnRuleGroup.IPSetForwardedIPConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

@Stability(Stable)
public static interface CfnRuleGroup.IPSetForwardedIPConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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, 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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wafv2.*;
 IPSetForwardedIPConfigurationProperty iPSetForwardedIPConfigurationProperty = Map.of(
         "fallbackBehavior", "fallbackBehavior",
         "headerName", "headerName",
         "position", "position");
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetforwardedipconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Builder	A builder for CfnRuleGroup.IPSetForwardedIPConfigurationProperty
static final class	CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Jsii$Proxy	An implementation for CfnRuleGroup.IPSetForwardedIPConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Builder	builder()
String	getFallbackBehavior()	The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
String	getHeaderName()	The name of the HTTP header to use for the IP address.
String	getPosition()	The position in the header to search for the IP address.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFallbackBehavior

@Stability(Stable)
@NotNull
String getFallbackBehavior()

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, AWS 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. AWS WAF applies the rule action to the request.
• NO_MATCH - Treat the web request as not matching the rule statement.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetforwardedipconfiguration.html#cfn-wafv2-rulegroup-ipsetforwardedipconfiguration-fallbackbehavior

getHeaderName

@Stability(Stable)
@NotNull
String getHeaderName()

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, AWS WAF doesn't apply the rule to the web request at all.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetforwardedipconfiguration.html#cfn-wafv2-rulegroup-ipsetforwardedipconfiguration-headername

getPosition

@Stability(Stable)
@NotNull
String getPosition()

The position in the header to search for the IP address.

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:

• FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
• LAST - Inspect the last IP address in the list of IP addresses in the header.
• ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetforwardedipconfiguration.html#cfn-wafv2-rulegroup-ipsetforwardedipconfiguration-position

builder

@Stability(Stable)
static CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Builder builder()

Returns:

a CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Builder of CfnRuleGroup.IPSetForwardedIPConfigurationProperty