Package software.amazon.awssdk.services.wafv2.model

Interface UpdateWebAclRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateWebAclRequest.Builder,UpdateWebAclRequest>, SdkBuilder<UpdateWebAclRequest.Builder,UpdateWebAclRequest>, SdkPojo, SdkRequest.Builder, Wafv2Request.Builder
Enclosing class:
UpdateWebAclRequest
public static interface UpdateWebAclRequest.Builder extends Wafv2Request.Builder, SdkPojo, CopyableBuilder<UpdateWebAclRequest.Builder,UpdateWebAclRequest>

  • Method Details

    • name

      UpdateWebAclRequest.Builder name(String name)

      The name of the web ACL. You cannot change the name of a web ACL after you create it.

      Parameters:
      name - The name of the web ACL. You cannot change the name of a web ACL after you create it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scope

      UpdateWebAclRequest.Builder scope(String scope)

      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.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Parameters:
      scope - 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.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scope

      UpdateWebAclRequest.Builder scope(Scope scope)

      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.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Parameters:
      scope - 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.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • id

      UpdateWebAclRequest.Builder id(String id)

      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.

      Parameters:
      id - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultAction

      UpdateWebAclRequest.Builder defaultAction(DefaultAction defaultAction)

      The action to perform if none of the Rules contained in the WebACL match.

      Parameters:
      defaultAction - The action to perform if none of the Rules contained in the WebACL match.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultAction

      default UpdateWebAclRequest.Builder defaultAction(Consumer<DefaultAction.Builder> defaultAction)

      The action to perform if none of the Rules contained in the WebACL match.

      This is a convenience method that creates an instance of the DefaultAction.Builder avoiding the need to create one manually via DefaultAction.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultAction(DefaultAction).

      Parameters:
      defaultAction - a consumer that will call methods on DefaultAction.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      UpdateWebAclRequest.Builder description(String description)

      A description of the web ACL that helps with identification.

      Parameters:
      description - A description of the web ACL that helps with identification.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rules

      UpdateWebAclRequest.Builder rules(Collection<Rule> rules)

      The Rule 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.

      Parameters:
      rules - The Rule 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rules

      UpdateWebAclRequest.Builder rules(Rule... rules)

      The Rule 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.

      Parameters:
      rules - The Rule 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rules

      UpdateWebAclRequest.Builder rules(Consumer<Rule.Builder>... rules)

      The Rule 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.

      This is a convenience method that creates an instance of the Rule.Builder avoiding the need to create one manually via Rule.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rules(List<Rule>).

      Parameters:
      rules - a consumer that will call methods on Rule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • visibilityConfig

      UpdateWebAclRequest.Builder visibilityConfig(VisibilityConfig visibilityConfig)

      Defines and enables Amazon CloudWatch metrics and web request sample collection.

      Parameters:
      visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • visibilityConfig

      default UpdateWebAclRequest.Builder visibilityConfig(Consumer<VisibilityConfig.Builder> visibilityConfig)

      Defines and enables Amazon CloudWatch metrics and web request sample collection.

      This is a convenience method that creates an instance of the VisibilityConfig.Builder avoiding the need to create one manually via VisibilityConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to visibilityConfig(VisibilityConfig).

      Parameters:
      visibilityConfig - a consumer that will call methods on VisibilityConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lockToken

      UpdateWebAclRequest.Builder lockToken(String lockToken)

      A token used for optimistic locking. WAF returns a token to your get and list 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 update and delete. 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 WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

      Parameters:
      lockToken - A token used for optimistic locking. WAF returns a token to your get and list 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 update and delete. 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 WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customResponseBodies

      UpdateWebAclRequest.Builder customResponseBodies(Map<String,CustomResponseBody> customResponseBodies)

      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.

      For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

      For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

      Parameters:
      customResponseBodies - 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.

      For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

      For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • captchaConfig

      UpdateWebAclRequest.Builder captchaConfig(CaptchaConfig captchaConfig)

      Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

      Parameters:
      captchaConfig - Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • captchaConfig

      default UpdateWebAclRequest.Builder captchaConfig(Consumer<CaptchaConfig.Builder> captchaConfig)

      Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

      This is a convenience method that creates an instance of the CaptchaConfig.Builder avoiding the need to create one manually via CaptchaConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to captchaConfig(CaptchaConfig).

      Parameters:
      captchaConfig - a consumer that will call methods on CaptchaConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • challengeConfig

      UpdateWebAclRequest.Builder challengeConfig(ChallengeConfig challengeConfig)

      Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

      Parameters:
      challengeConfig - Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • challengeConfig

      default UpdateWebAclRequest.Builder challengeConfig(Consumer<ChallengeConfig.Builder> challengeConfig)

      Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

      This is a convenience method that creates an instance of the ChallengeConfig.Builder avoiding the need to create one manually via ChallengeConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to challengeConfig(ChallengeConfig).

      Parameters:
      challengeConfig - a consumer that will call methods on ChallengeConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tokenDomains

      UpdateWebAclRequest.Builder tokenDomains(Collection<String> tokenDomains)

      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.

      Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

      Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

      Parameters:
      tokenDomains - 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.

      Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

      Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tokenDomains

      UpdateWebAclRequest.Builder tokenDomains(String... tokenDomains)

      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.

      Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

      Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

      Parameters:
      tokenDomains - 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.

      Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

      Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associationConfig

      UpdateWebAclRequest.Builder associationConfig(AssociationConfig associationConfig)

      Specifies custom configurations for the associations between the web ACL and protected resources.

      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).

      You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

      For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

      Parameters:
      associationConfig - Specifies custom configurations for the associations between the web ACL and protected resources.

      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).

      You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

      For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associationConfig

      default UpdateWebAclRequest.Builder associationConfig(Consumer<AssociationConfig.Builder> associationConfig)

      Specifies custom configurations for the associations between the web ACL and protected resources.

      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).

      You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

      For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

      This is a convenience method that creates an instance of the AssociationConfig.Builder avoiding the need to create one manually via AssociationConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to associationConfig(AssociationConfig).

      Parameters:
      associationConfig - a consumer that will call methods on AssociationConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateWebAclRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateWebAclRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.