aws_sdk_wafv2/client/

update_ip_set.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateIPSet`](crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder::set_name):<br>required: **true**<br><p>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</p><br>
    ///   - [`scope(Scope)`](crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder::scope) / [`set_scope(Option<Scope>)`](crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder::set_scope):<br>required: **true**<br><p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.</p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p> <ul>  <li>   <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>  <li>   <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li> </ul><br>
    ///   - [`id(impl Into<String>)`](crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder::set_id):<br>required: **true**<br><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><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder::set_description):<br>required: **false**<br><p>A description of the IP set that helps with identification.</p><br>
    ///   - [`addresses(impl Into<String>)`](crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder::addresses) / [`set_addresses(Option<Vec::<String>>)`](crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder::set_addresses):<br>required: **true**<br><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><br>
    ///   - [`lock_token(impl Into<String>)`](crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder::lock_token) / [`set_lock_token(Option<String>)`](crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder::set_lock_token):<br>required: **true**<br><p>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like <code>update</code> and <code>delete</code>. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another <code>get</code>, and use the new token returned by that operation.</p><br>
    /// - On success, responds with [`UpdateIpSetOutput`](crate::operation::update_ip_set::UpdateIpSetOutput) with field(s):
    ///   - [`next_lock_token(Option<String>)`](crate::operation::update_ip_set::UpdateIpSetOutput::next_lock_token): <p>A token used for optimistic locking. WAF returns this token to your <code>update</code> requests. You use <code>NextLockToken</code> in the same manner as you use <code>LockToken</code>.</p>
    /// - On failure, responds with [`SdkError<UpdateIPSetError>`](crate::operation::update_ip_set::UpdateIPSetError)
    pub fn update_ip_set(&self) -> crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder {
        crate::operation::update_ip_set::builders::UpdateIPSetFluentBuilder::new(self.handle.clone())
    }
}