GetWebAclResult

data class GetWebAclResult(val arn: String? = null, val associationConfig: WebAclAssociationConfig? = null, val capacity: Int? = null, val captchaConfig: WebAclCaptchaConfig? = null, val challengeConfig: WebAclChallengeConfig? = null, val customResponseBodies: Map<String, WebAclCustomResponseBody>? = null, val defaultAction: WebAclDefaultAction? = null, val description: String? = null, val id: String? = null, val labelNamespace: String? = null, val rules: List<WebAclRule>? = null, val tags: List<Tag>? = null, val tokenDomains: List<String>? = null, val visibilityConfig: WebAclVisibilityConfig? = null)

Constructors

Link copied to clipboard
constructor(arn: String? = null, associationConfig: WebAclAssociationConfig? = null, capacity: Int? = null, captchaConfig: WebAclCaptchaConfig? = null, challengeConfig: WebAclChallengeConfig? = null, customResponseBodies: Map<String, WebAclCustomResponseBody>? = null, defaultAction: WebAclDefaultAction? = null, description: String? = null, id: String? = null, labelNamespace: String? = null, rules: List<WebAclRule>? = null, tags: List<Tag>? = null, tokenDomains: List<String>? = null, visibilityConfig: WebAclVisibilityConfig? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String? = null

The Amazon Resource Name (ARN) of the web ACL.

Link copied to clipboard

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

Link copied to clipboard
val capacity: Int? = null

The web ACL capacity units (WCUs) currently being used by this web ACL. AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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 AWS WAF in the AWS WAF Developer Guide . For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .

Link copied to clipboard

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

Link copied to clipboard
val description: String? = null

A description of the web ACL that helps with identification.

Link copied to clipboard
val id: String? = null

The ID of the web ACL.

Link copied to clipboard
val labelNamespace: String? = null

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix. The syntax for the label namespace prefix for a web ACL is the following: awswaf:<account ID>:webacl:<web ACL name>: When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon.

Link copied to clipboard
val rules: List<WebAclRule>? = null

Collection of Rules.

Link copied to clipboard
val tags: List<Tag>? = null

Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

Link copied to clipboard
val tokenDomains: List<String>? = null

Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Link copied to clipboard

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