Interface CfnRuleGroup.ForwardedIPConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnRuleGroup.ForwardedIPConfigurationProperty.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 for GeoMatchStatement
and RateBasedStatement
. For IPSetReferenceStatement
, use IPSetForwardedIPConfig
instead.
AWS WAF only evaluates the first IP address found in the specified HTTP header.
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.*; ForwardedIPConfigurationProperty forwardedIPConfigurationProperty = ForwardedIPConfigurationProperty.builder() .fallbackBehavior("fallbackBehavior") .headerName("headerName") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnRuleGroup.ForwardedIPConfigurationProperty
static final class
An implementation forCfnRuleGroup.ForwardedIPConfigurationProperty
-
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.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.
- See Also:
-
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:
-
builder
-