Struct IpSetReferenceStatement

#[non_exhaustive]
pub struct IpSetReferenceStatement {
    pub arn: String,
    pub ip_set_forwarded_ip_config: Option<IpSetForwardedIpConfig>,
}

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

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.

arn: String

The Amazon Resource Name (ARN) of the IPSet that this statement references.

ip_set_forwarded_ip_config: Option<IpSetForwardedIpConfig>

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.

Implementations

impl IpSetReferenceStatement

pub fn arn(&self) -> &str

The Amazon Resource Name (ARN) of the IPSet that this statement references.

pub fn ip_set_forwarded_ip_config(&self) -> Option<&IpSetForwardedIpConfig>

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.

impl IpSetReferenceStatement

pub fn builder() -> IpSetReferenceStatementBuilder

Creates a new builder-style object to manufacture IpSetReferenceStatement.

Trait Implementations

impl Clone for IpSetReferenceStatement

fn clone(&self) -> IpSetReferenceStatement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpSetReferenceStatement

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

Formats the value using the given formatter.

impl PartialEq for IpSetReferenceStatement

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for IpSetReferenceStatement