Struct aws_sdk_wafv2::types::builders::IpSetForwardedIpConfigBuilder

#[non_exhaustive]
pub struct IpSetForwardedIpConfigBuilder { /* private fields */ }

A builder for IpSetForwardedIpConfig.

Implementations

impl IpSetForwardedIpConfigBuilder

pub fn header_name(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_header_name(self, input: Option<String>) -> Self

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 get_header_name(&self) -> &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.

pub fn fallback_behavior(self, input: FallbackBehavior) -> Self

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.

This field is required.

pub fn set_fallback_behavior(self, input: Option<FallbackBehavior>) -> Self

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 get_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, input: ForwardedIpPosition) -> Self

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.

This field is required.

pub fn set_position(self, input: Option<ForwardedIpPosition>) -> Self

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.

pub fn get_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.

pub fn build(self) -> Result<IpSetForwardedIpConfig, BuildError>

Consumes the builder and constructs a IpSetForwardedIpConfig. This method will fail if any of the following fields are not set:

• header_name
• fallback_behavior
• position

Trait Implementations

impl Clone for IpSetForwardedIpConfigBuilder

fn clone(&self) -> IpSetForwardedIpConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpSetForwardedIpConfigBuilder

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

Formats the value using the given formatter.

impl Default for IpSetForwardedIpConfigBuilder

fn default() -> IpSetForwardedIpConfigBuilder

Returns the “default value” for a type.

impl PartialEq for IpSetForwardedIpConfigBuilder

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IpSetForwardedIpConfigBuilder