WebAclRuleArgs

data class WebAclRuleArgs(val action: Output<WebAclRuleActionArgs>? = null, val captchaConfig: Output<WebAclCaptchaConfigArgs>? = null, val challengeConfig: Output<WebAclChallengeConfigArgs>? = null, val name: Output<String>, val overrideAction: Output<WebAclOverrideActionArgs>? = null, val priority: Output<Int>, val ruleLabels: Output<List<WebAclLabelArgs>>? = null, val statement: Output<WebAclStatementArgs>, val visibilityConfig: Output<WebAclVisibilityConfigArgs>) : ConvertibleToJava<WebAclRuleArgs>

Rule of WebACL that contains condition and action.

Constructors

Link copied to clipboard
constructor(action: Output<WebAclRuleActionArgs>? = null, captchaConfig: Output<WebAclCaptchaConfigArgs>? = null, challengeConfig: Output<WebAclChallengeConfigArgs>? = null, name: Output<String>, overrideAction: Output<WebAclOverrideActionArgs>? = null, priority: Output<Int>, ruleLabels: Output<List<WebAclLabelArgs>>? = null, statement: Output<WebAclStatementArgs>, visibilityConfig: Output<WebAclVisibilityConfigArgs>)

Properties

Link copied to clipboard
val action: Output<WebAclRuleActionArgs>? = null

The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting. This is used only for rules whose statements don't reference a rule group. Rule statements that reference a rule group are RuleGroupReferenceStatement and ManagedRuleGroupStatement . You must set either this Action setting or the rule's OverrideAction , but not both:

Link copied to clipboard

Specifies how AWS WAF should handle CAPTCHA evaluations. If you don't specify this, AWS WAF uses the CAPTCHA configuration that's defined for the web ACL.

Link copied to clipboard

Specifies how AWS WAF should handle Challenge evaluations. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL.

Link copied to clipboard
val name: Output<String>

The name of the rule. If you change the name of a Rule after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule's VisibilityConfig settings. AWS WAF doesn't automatically update the metric name when you update the rule name.

Link copied to clipboard

The override action to apply to the rules in a rule group, instead of the individual rule action settings. This is used only for rules whose statements reference a rule group. Rule statements that reference a rule group are RuleGroupReferenceStatement and ManagedRuleGroupStatement . Set the override action to none to leave the rule group rule actions in effect. Set it to count to only count matches, regardless of the rule action settings. You must set either this OverrideAction setting or the Action setting, but not both:

Link copied to clipboard
val priority: Output<Int>

If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority . AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

Link copied to clipboard
val ruleLabels: Output<List<WebAclLabelArgs>>? = null

Collection of Rule Labels.

Link copied to clipboard

The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .

Link copied to clipboard

Defines and enables Amazon CloudWatch metrics and web request sample collection. If you change the name of a Rule after you create it and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF doesn't automatically update the metric name.

Functions

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