Struct aws_sdk_wafv2::types::IpSet

#[non_exhaustive]
pub struct IpSet {
    pub name: String,
    pub id: String,
    pub arn: String,
    pub description: Option<String>,
    pub ip_address_version: IpAddressVersion,
    pub addresses: Vec<String>,
}

Contains zero or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

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.

name: String

The name of the IP set. You cannot change the name of an IPSet after you create it.

id: String

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

arn: String

The Amazon Resource Name (ARN) of the entity.

description: Option<String>

A description of the IP set that helps with identification.

ip_address_version: IpAddressVersion

The version of the IP addresses, either IPV4 or IPV6.

addresses: Vec<String>

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Example address strings:

• For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

• For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

• For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

• For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Example JSON Addresses specifications:

• Empty array: "Addresses": []

• Array with one address: "Addresses": ["192.0.2.44/32"]

• Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

• INVALID specification: "Addresses": [""] INVALID

Implementations

impl IpSet

pub fn name(&self) -> &str

The name of the IP set. You cannot change the name of an IPSet after you create it.

pub fn id(&self) -> &str

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

pub fn arn(&self) -> &str

The Amazon Resource Name (ARN) of the entity.

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

A description of the IP set that helps with identification.

pub fn ip_address_version(&self) -> &IpAddressVersion

The version of the IP addresses, either IPV4 or IPV6.

pub fn addresses(&self) -> &[String]

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Example address strings:

• For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

• For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

• For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

• For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Example JSON Addresses specifications:

• Empty array: "Addresses": []

• Array with one address: "Addresses": ["192.0.2.44/32"]

• Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

• INVALID specification: "Addresses": [""] INVALID

impl IpSet

pub fn builder() -> IpSetBuilder

Creates a new builder-style object to manufacture IpSet.

Trait Implementations

impl Clone for IpSet

fn clone(&self) -> IpSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpSet

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

Formats the value using the given formatter.

impl PartialEq for IpSet

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