wafv2/aws.sdk.kotlin.services.wafv2.model/CreateWebAclRequest/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.

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.

name

var name: String?

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

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

tags

var tags: List<Tag>?

An array of key:value pairs to associate with the resource.

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.