Interface CfnRuleGroup.IPSetForwardedIPConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Jsii$Proxy
- Enclosing class:
- CfnRuleGroup
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");
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnRuleGroup.IPSetForwardedIPConfigurationProperty
static final class
An implementation forCfnRuleGroup.IPSetForwardedIPConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.The name of the HTTP header to use for the IP address.The position in the header to search for the IP address.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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.
-
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.
-
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.
-
builder
-