wafv2/aws.sdk.kotlin.services.wafv2.model/UpdateWebAclRequest/Builder

Builder

Properties

var associationConfig: AssociationConfig?

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

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.

challengeConfig

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

customResponseBodies

var customResponseBodies: Map<String, CustomResponseBody>?

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.

dataProtectionConfig

var dataProtectionConfig: DataProtectionConfig?

Specifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option.

defaultAction

var defaultAction: DefaultAction?

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

description

var description: String?

A description of the web ACL that helps with identification.

var id: String?

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.

lockToken

var lockToken: String?

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.

name

var name: String?

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

onSourceDDoSProtectionConfig

var onSourceDDoSProtectionConfig: OnSourceDDoSProtectionConfig?

Specifies the type of DDoS protection to apply to web request data for a web ACL. For most scenarios, it is recommended to use the default protection level, ACTIVE_UNDER_DDOS. If a web ACL is associated with multiple Application Load Balancers, the changes you make to DDoS protection in that web ACL will apply to all associated Application Load Balancers.

rules

var rules: List<Rule>?

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.

scope

var scope: Scope?

Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

tokenDomains

var tokenDomains: List<String>?

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.

visibilityConfig

var visibilityConfig: VisibilityConfig?

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