1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>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 <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>.</p>
/// <p>WAF assigns an ARN to each <code>IPSet</code> that you create. To use an IP set in a rule, you provide the ARN to the <code>Rule</code> statement <code>IPSetReferenceStatement</code>.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct IpSet {
/// <p>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</p>
pub name: ::std::string::String,
/// <p>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.</p>
pub id: ::std::string::String,
/// <p>The Amazon Resource Name (ARN) of the entity.</p>
pub arn: ::std::string::String,
/// <p>A description of the IP set that helps with identification.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The version of the IP addresses, either <code>IPV4</code> or <code>IPV6</code>.</p>
pub ip_address_version: crate::types::IpAddressVersion,
/// <p>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 <code>/0</code>.</p>
/// <p>Example address strings:</p>
/// <ul>
/// <li>
/// <p>For requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p></li>
/// <li>
/// <p>For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p></li>
/// <li>
/// <p>For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p></li>
/// <li>
/// <p>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 <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p></li>
/// </ul>
/// <p>For more information about CIDR notation, see the Wikipedia entry <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>.</p>
/// <p>Example JSON <code>Addresses</code> specifications:</p>
/// <ul>
/// <li>
/// <p>Empty array: <code>"Addresses": []</code></p></li>
/// <li>
/// <p>Array with one address: <code>"Addresses": ["192.0.2.44/32"]</code></p></li>
/// <li>
/// <p>Array with three addresses: <code>"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]</code></p></li>
/// <li>
/// <p>INVALID specification: <code>"Addresses": [""]</code> INVALID</p></li>
/// </ul>
pub addresses: ::std::vec::Vec<::std::string::String>,
}
impl IpSet {
/// <p>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</p>
pub fn name(&self) -> &str {
use std::ops::Deref;
self.name.deref()
}
/// <p>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.</p>
pub fn id(&self) -> &str {
use std::ops::Deref;
self.id.deref()
}
/// <p>The Amazon Resource Name (ARN) of the entity.</p>
pub fn arn(&self) -> &str {
use std::ops::Deref;
self.arn.deref()
}
/// <p>A description of the IP set that helps with identification.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The version of the IP addresses, either <code>IPV4</code> or <code>IPV6</code>.</p>
pub fn ip_address_version(&self) -> &crate::types::IpAddressVersion {
&self.ip_address_version
}
/// <p>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 <code>/0</code>.</p>
/// <p>Example address strings:</p>
/// <ul>
/// <li>
/// <p>For requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p></li>
/// <li>
/// <p>For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p></li>
/// <li>
/// <p>For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p></li>
/// <li>
/// <p>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 <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p></li>
/// </ul>
/// <p>For more information about CIDR notation, see the Wikipedia entry <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>.</p>
/// <p>Example JSON <code>Addresses</code> specifications:</p>
/// <ul>
/// <li>
/// <p>Empty array: <code>"Addresses": []</code></p></li>
/// <li>
/// <p>Array with one address: <code>"Addresses": ["192.0.2.44/32"]</code></p></li>
/// <li>
/// <p>Array with three addresses: <code>"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]</code></p></li>
/// <li>
/// <p>INVALID specification: <code>"Addresses": [""]</code> INVALID</p></li>
/// </ul>
pub fn addresses(&self) -> &[::std::string::String] {
use std::ops::Deref;
self.addresses.deref()
}
}
impl IpSet {
/// Creates a new builder-style object to manufacture [`IpSet`](crate::types::IpSet).
pub fn builder() -> crate::types::builders::IpSetBuilder {
crate::types::builders::IpSetBuilder::default()
}
}
/// A builder for [`IpSet`](crate::types::IpSet).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct IpSetBuilder {
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) id: ::std::option::Option<::std::string::String>,
pub(crate) arn: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) ip_address_version: ::std::option::Option<crate::types::IpAddressVersion>,
pub(crate) addresses: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
}
impl IpSetBuilder {
/// <p>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</p>
/// This field is required.
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>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.</p>
/// This field is required.
pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.id = ::std::option::Option::Some(input.into());
self
}
/// <p>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.</p>
pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.id = input;
self
}
/// <p>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.</p>
pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
&self.id
}
/// <p>The Amazon Resource Name (ARN) of the entity.</p>
/// This field is required.
pub fn arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the entity.</p>
pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the entity.</p>
pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.arn
}
/// <p>A description of the IP set that helps with identification.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>A description of the IP set that helps with identification.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>A description of the IP set that helps with identification.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The version of the IP addresses, either <code>IPV4</code> or <code>IPV6</code>.</p>
/// This field is required.
pub fn ip_address_version(mut self, input: crate::types::IpAddressVersion) -> Self {
self.ip_address_version = ::std::option::Option::Some(input);
self
}
/// <p>The version of the IP addresses, either <code>IPV4</code> or <code>IPV6</code>.</p>
pub fn set_ip_address_version(mut self, input: ::std::option::Option<crate::types::IpAddressVersion>) -> Self {
self.ip_address_version = input;
self
}
/// <p>The version of the IP addresses, either <code>IPV4</code> or <code>IPV6</code>.</p>
pub fn get_ip_address_version(&self) -> &::std::option::Option<crate::types::IpAddressVersion> {
&self.ip_address_version
}
/// Appends an item to `addresses`.
///
/// To override the contents of this collection use [`set_addresses`](Self::set_addresses).
///
/// <p>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 <code>/0</code>.</p>
/// <p>Example address strings:</p>
/// <ul>
/// <li>
/// <p>For requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p></li>
/// <li>
/// <p>For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p></li>
/// <li>
/// <p>For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p></li>
/// <li>
/// <p>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 <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p></li>
/// </ul>
/// <p>For more information about CIDR notation, see the Wikipedia entry <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>.</p>
/// <p>Example JSON <code>Addresses</code> specifications:</p>
/// <ul>
/// <li>
/// <p>Empty array: <code>"Addresses": []</code></p></li>
/// <li>
/// <p>Array with one address: <code>"Addresses": ["192.0.2.44/32"]</code></p></li>
/// <li>
/// <p>Array with three addresses: <code>"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]</code></p></li>
/// <li>
/// <p>INVALID specification: <code>"Addresses": [""]</code> INVALID</p></li>
/// </ul>
pub fn addresses(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.addresses.unwrap_or_default();
v.push(input.into());
self.addresses = ::std::option::Option::Some(v);
self
}
/// <p>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 <code>/0</code>.</p>
/// <p>Example address strings:</p>
/// <ul>
/// <li>
/// <p>For requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p></li>
/// <li>
/// <p>For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p></li>
/// <li>
/// <p>For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p></li>
/// <li>
/// <p>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 <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p></li>
/// </ul>
/// <p>For more information about CIDR notation, see the Wikipedia entry <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>.</p>
/// <p>Example JSON <code>Addresses</code> specifications:</p>
/// <ul>
/// <li>
/// <p>Empty array: <code>"Addresses": []</code></p></li>
/// <li>
/// <p>Array with one address: <code>"Addresses": ["192.0.2.44/32"]</code></p></li>
/// <li>
/// <p>Array with three addresses: <code>"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]</code></p></li>
/// <li>
/// <p>INVALID specification: <code>"Addresses": [""]</code> INVALID</p></li>
/// </ul>
pub fn set_addresses(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.addresses = input;
self
}
/// <p>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 <code>/0</code>.</p>
/// <p>Example address strings:</p>
/// <ul>
/// <li>
/// <p>For requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p></li>
/// <li>
/// <p>For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p></li>
/// <li>
/// <p>For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p></li>
/// <li>
/// <p>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 <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p></li>
/// </ul>
/// <p>For more information about CIDR notation, see the Wikipedia entry <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>.</p>
/// <p>Example JSON <code>Addresses</code> specifications:</p>
/// <ul>
/// <li>
/// <p>Empty array: <code>"Addresses": []</code></p></li>
/// <li>
/// <p>Array with one address: <code>"Addresses": ["192.0.2.44/32"]</code></p></li>
/// <li>
/// <p>Array with three addresses: <code>"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]</code></p></li>
/// <li>
/// <p>INVALID specification: <code>"Addresses": [""]</code> INVALID</p></li>
/// </ul>
pub fn get_addresses(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.addresses
}
/// Consumes the builder and constructs a [`IpSet`](crate::types::IpSet).
/// This method will fail if any of the following fields are not set:
/// - [`name`](crate::types::builders::IpSetBuilder::name)
/// - [`id`](crate::types::builders::IpSetBuilder::id)
/// - [`arn`](crate::types::builders::IpSetBuilder::arn)
/// - [`ip_address_version`](crate::types::builders::IpSetBuilder::ip_address_version)
/// - [`addresses`](crate::types::builders::IpSetBuilder::addresses)
pub fn build(self) -> ::std::result::Result<crate::types::IpSet, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::types::IpSet {
name: self.name.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"name",
"name was not specified but it is required when building IpSet",
)
})?,
id: self.id.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field("id", "id was not specified but it is required when building IpSet")
})?,
arn: self.arn.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field("arn", "arn was not specified but it is required when building IpSet")
})?,
description: self.description,
ip_address_version: self.ip_address_version.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"ip_address_version",
"ip_address_version was not specified but it is required when building IpSet",
)
})?,
addresses: self.addresses.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"addresses",
"addresses was not specified but it is required when building IpSet",
)
})?,
})
}
}