Struct aws_sdk_wafv2::types::builders::ForwardedIpConfigBuilder

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

A builder for ForwardedIpConfig.

Implementations

impl ForwardedIpConfigBuilder

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 build(self) -> Result<ForwardedIpConfig, BuildError>

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

• header_name
• fallback_behavior

Trait Implementations

impl Clone for ForwardedIpConfigBuilder

fn clone(&self) -> ForwardedIpConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ForwardedIpConfigBuilder

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

Formats the value using the given formatter.

impl Default for ForwardedIpConfigBuilder

fn default() -> ForwardedIpConfigBuilder

Returns the “default value” for a type.

impl PartialEq for ForwardedIpConfigBuilder

fn eq(&self, other: &ForwardedIpConfigBuilder) -> 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 ForwardedIpConfigBuilder