#[non_exhaustive]pub struct IpSetForwardedIpConfigBuilder { /* private fields */ }
Expand description
A builder for IpSetForwardedIpConfig
.
Implementations§
source§impl IpSetForwardedIpConfigBuilder
impl IpSetForwardedIpConfigBuilder
sourcepub fn header_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_header_name(self, input: Option<String>) -> Self
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.
sourcepub fn get_header_name(&self) -> &Option<String>
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.
sourcepub fn fallback_behavior(self, input: FallbackBehavior) -> Self
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.
sourcepub fn set_fallback_behavior(self, input: Option<FallbackBehavior>) -> Self
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.
sourcepub fn get_fallback_behavior(&self) -> &Option<FallbackBehavior>
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.
sourcepub fn position(self, input: ForwardedIpPosition) -> Self
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.
sourcepub fn set_position(self, input: Option<ForwardedIpPosition>) -> Self
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.
sourcepub fn get_position(&self) -> &Option<ForwardedIpPosition>
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.
sourcepub fn build(self) -> Result<IpSetForwardedIpConfig, BuildError>
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:
Trait Implementations§
source§impl Clone for IpSetForwardedIpConfigBuilder
impl Clone for IpSetForwardedIpConfigBuilder
source§fn clone(&self) -> IpSetForwardedIpConfigBuilder
fn clone(&self) -> IpSetForwardedIpConfigBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for IpSetForwardedIpConfigBuilder
impl Default for IpSetForwardedIpConfigBuilder
source§fn default() -> IpSetForwardedIpConfigBuilder
fn default() -> IpSetForwardedIpConfigBuilder
source§impl PartialEq for IpSetForwardedIpConfigBuilder
impl PartialEq for IpSetForwardedIpConfigBuilder
source§fn eq(&self, other: &IpSetForwardedIpConfigBuilder) -> bool
fn eq(&self, other: &IpSetForwardedIpConfigBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.