aws_sdk_wafv2/client/

update_web_acl.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateWebACL`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::set_name):<br>required: **true**<br><p>The name of the web ACL. You cannot change the name of a web ACL after you create it.</p><br>
    ///   - [`scope(Scope)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::scope) / [`set_scope(Option<Scope>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::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_web_acl::builders::UpdateWebACLFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::set_id):<br>required: **true**<br><p>The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p><br>
    ///   - [`default_action(DefaultAction)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::default_action) / [`set_default_action(Option<DefaultAction>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::set_default_action):<br>required: **true**<br><p>The action to perform if none of the <code>Rules</code> contained in the <code>WebACL</code> match.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::set_description):<br>required: **false**<br><p>A description of the web ACL that helps with identification.</p><br>
    ///   - [`rules(Rule)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::rules) / [`set_rules(Option<Vec::<Rule>>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::set_rules):<br>required: **false**<br><p>The <code>Rule</code> statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.</p><br>
    ///   - [`visibility_config(VisibilityConfig)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::visibility_config) / [`set_visibility_config(Option<VisibilityConfig>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::set_visibility_config):<br>required: **true**<br><p>Defines and enables Amazon CloudWatch metrics and web request sample collection.</p><br>
    ///   - [`lock_token(impl Into<String>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::lock_token) / [`set_lock_token(Option<String>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::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>
    ///   - [`custom_response_bodies(impl Into<String>, CustomResponseBody)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::custom_response_bodies) / [`set_custom_response_bodies(Option<HashMap::<String, CustomResponseBody>>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::set_custom_response_bodies):<br>required: **false**<br><p>A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.</p> <p>For information about customizing web requests and responses, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>.</p> <p>For information about the limits on count and size for custom request and response settings, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the <i>WAF Developer Guide</i>.</p><br>
    ///   - [`captcha_config(CaptchaConfig)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::captcha_config) / [`set_captcha_config(Option<CaptchaConfig>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::set_captcha_config):<br>required: **false**<br><p>Specifies how WAF should handle <code>CAPTCHA</code> evaluations for rules that don't have their own <code>CaptchaConfig</code> settings. If you don't specify this, WAF uses its default settings for <code>CaptchaConfig</code>.</p><br>
    ///   - [`challenge_config(ChallengeConfig)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::challenge_config) / [`set_challenge_config(Option<ChallengeConfig>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::set_challenge_config):<br>required: **false**<br><p>Specifies how WAF should handle challenge evaluations for rules that don't have their own <code>ChallengeConfig</code> settings. If you don't specify this, WAF uses its default settings for <code>ChallengeConfig</code>.</p><br>
    ///   - [`token_domains(impl Into<String>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::token_domains) / [`set_token_domains(Option<Vec::<String>>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::set_token_domains):<br>required: **false**<br><p>Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.</p> <p>Example JSON: <code>"TokenDomains": { "mywebsite.com", "myotherwebsite.com" }</code></p> <p>Public suffixes aren't allowed. For example, you can't use <code>gov.au</code> or <code>co.uk</code> as token domains.</p><br>
    ///   - [`association_config(AssociationConfig)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::association_config) / [`set_association_config(Option<AssociationConfig>)`](crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::set_association_config):<br>required: **false**<br><p>Specifies custom configurations for the associations between the web ACL and protected resources.</p> <p>Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).</p><note>  <p>You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see <a href="http://aws.amazon.com/waf/pricing/">WAF Pricing</a>.</p> </note> <p>For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).</p><br>
    /// - On success, responds with [`UpdateWebAclOutput`](crate::operation::update_web_acl::UpdateWebAclOutput) with field(s):
    ///   - [`next_lock_token(Option<String>)`](crate::operation::update_web_acl::UpdateWebAclOutput::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<UpdateWebACLError>`](crate::operation::update_web_acl::UpdateWebACLError)
    pub fn update_web_acl(&self) -> crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder {
        crate::operation::update_web_acl::builders::UpdateWebACLFluentBuilder::new(self.handle.clone())
    }
}