Struct aws_sdk_wafv2::types::builders::IpSetBuilder

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

A builder for IpSet.

Implementations

impl IpSetBuilder

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

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

This field is required.

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

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

pub fn get_name(&self) -> &Option<String>

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

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

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.

This field is required.

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

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

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

The Amazon Resource Name (ARN) of the entity.

This field is required.

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

The Amazon Resource Name (ARN) of the entity.

pub fn get_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the entity.

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

A description of the IP set that helps with identification.

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

A description of the IP set that helps with identification.

pub fn get_description(&self) -> &Option<String>

A description of the IP set that helps with identification.

pub fn ip_address_version(self, input: IpAddressVersion) -> Self

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

This field is required.

pub fn set_ip_address_version(self, input: Option<IpAddressVersion>) -> Self

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

pub fn get_ip_address_version(&self) -> &Option<IpAddressVersion>

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

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

Appends an item to addresses.

To override the contents of this collection use set_addresses.

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

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

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

pub fn get_addresses(&self) -> &Option<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

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

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

• name
• id
• arn
• ip_address_version
• addresses

Trait Implementations

impl Clone for IpSetBuilder

fn clone(&self) -> IpSetBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpSetBuilder

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

Formats the value using the given formatter.

impl Default for IpSetBuilder

fn default() -> IpSetBuilder

Returns the “default value” for a type.

impl PartialEq for IpSetBuilder

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