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

Builder

class Builder

Properties

arn

var arn: String?

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

associationConfig

var associationConfig: AssociationConfig?

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

capacity

var capacity: Long

The web ACL capacity units (WCUs) currently being used by this web ACL.

captchaConfig

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

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.

var id: String?

A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL.

labelNamespace

var labelNamespace: String?

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.

managedByFirewallManager

var managedByFirewallManager: Boolean

Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.

name

var name: String?

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

postProcessFirewallManagerRuleGroups

var postProcessFirewallManagerRuleGroups: List<FirewallManagerRuleGroup>?

The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.

preProcessFirewallManagerRuleGroups

var preProcessFirewallManagerRuleGroups: List<FirewallManagerRuleGroup>?

The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.

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.

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.