Struct aws_sdk_wafv2::model::IpSetForwardedIpConfig

#[non_exhaustive]
pub struct IpSetForwardedIpConfig {
    pub header_name: Option<String>,
    pub fallback_behavior: Option<FallbackBehavior>,
    pub position: Option<ForwardedIpPosition>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

header_name: Option<String>

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

fallback_behavior: Option<FallbackBehavior>

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, 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. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

position: Option<ForwardedIpPosition>

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, WAF inspects the last 10.

Implementations

impl IpSetForwardedIpConfig

pub fn header_name(&self) -> Option<&str>

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

pub fn fallback_behavior(&self) -> Option<&FallbackBehavior>

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, 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. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

pub fn position(&self) -> Option<&ForwardedIpPosition>

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, WAF inspects the last 10.

impl IpSetForwardedIpConfig

pub fn builder() -> Builder

Creates a new builder-style object to manufacture IpSetForwardedIpConfig

Trait Implementations

impl Clone for IpSetForwardedIpConfig

fn clone(&self) -> IpSetForwardedIpConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IpSetForwardedIpConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<IpSetForwardedIpConfig> for IpSetForwardedIpConfig

fn eq(&self, other: &IpSetForwardedIpConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &IpSetForwardedIpConfig) -> bool

This method tests for !=.

impl StructuralPartialEq for IpSetForwardedIpConfig