WebAclArgs

data class WebAclArgs(val associationConfig: Output<WebAclAssociationConfigArgs>? = null, val captchaConfig: Output<WebAclCaptchaConfigArgs>? = null, val challengeConfig: Output<WebAclChallengeConfigArgs>? = null, val customResponseBodies: Output<Map<String, WebAclCustomResponseBodyArgs>>? = null, val defaultAction: Output<WebAclDefaultActionArgs>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val rules: Output<List<WebAclRuleArgs>>? = null, val scope: Output<WebAclScope>? = null, val tags: Output<List<TagArgs>>? = null, val tokenDomains: Output<List<String>>? = null, val visibilityConfig: Output<WebAclVisibilityConfigArgs>? = null) : ConvertibleToJava<WebAclArgs>

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted.

Constructors

Link copied to clipboard
constructor(associationConfig: Output<WebAclAssociationConfigArgs>? = null, captchaConfig: Output<WebAclCaptchaConfigArgs>? = null, challengeConfig: Output<WebAclChallengeConfigArgs>? = null, customResponseBodies: Output<Map<String, WebAclCustomResponseBodyArgs>>? = null, defaultAction: Output<WebAclDefaultActionArgs>? = null, description: Output<String>? = null, name: Output<String>? = null, rules: Output<List<WebAclRuleArgs>>? = null, scope: Output<WebAclScope>? = null, tags: Output<List<TagArgs>>? = null, tokenDomains: Output<List<String>>? = null, visibilityConfig: Output<WebAclVisibilityConfigArgs>? = null)

Properties

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

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: Output<String>? = null

A description of the web ACL that helps with identification.

Link copied to clipboard
val name: Output<String>? = null

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

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

Collection of Rules.

Link copied to clipboard
val scope: Output<WebAclScope>? = null

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 AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are CLOUDFRONT and REGIONAL .

Link copied to clipboard
val tags: Output<List<TagArgs>>? = 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: Output<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.

Functions

Link copied to clipboard
open override fun toJava(): WebAclArgs