Package com.pulumi.aws.wafv2.outputs

Class WebAclRule

  • public final class WebAclRule
extends java.lang.Object

    • Method Detail

      • action

        public java.util.Optional<WebAclRuleAction> action()
        Returns:
        Action that AWS WAF should take on a web request when it matches the rule's statement. This is used only for rules whose **statements do not reference a rule group**. See `action` for details.

      • captchaConfig

        public java.util.Optional<WebAclRuleCaptchaConfig> captchaConfig()
        Returns:
        Configuration for how AWS WAF handles CAPTCHA evaluations. See `captchaConfig` below for details.

      • challengeConfig

        public java.util.Optional<WebAclRuleChallengeConfig> challengeConfig()
        Returns:
        Configuration for how AWS WAF handles Challenge evaluations at the rule level. See `challengeConfig` below for details.

      • name

        public java.lang.String name()
        Returns:
        Friendly name of the rule. Note that the provider assumes that rules with names matching this pattern, `^ShieldMitigationRuleGroup_<account-id>_<web-acl-guid>_.*`, are AWS-added for [automatic application layer DDoS mitigation activities](https://docs.aws.amazon.com/waf/latest/developerguide/ddos-automatic-app-layer-response-rg.html). Such rules will be ignored by the provider unless you explicitly include them in your configuration (for example, by using the AWS CLI to discover their properties and creating matching configuration). However, since these rules are owned and managed by AWS, you may get permission errors.

      • overrideAction

        public java.util.Optional<WebAclRuleOverrideAction> overrideAction()
        Returns:
        Override action to apply to the rules in a rule group. Used only for rule **statements that reference a rule group**, like `ruleGroupReferenceStatement` and `managedRuleGroupStatement`. See `overrideAction` below for details.

      • priority

        public java.lang.Integer priority()
        Returns:
        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.

      • ruleLabels

        public java.util.List<WebAclRuleRuleLabel> ruleLabels()
        Returns:
        Labels to apply to web requests that match the rule match statement. See `ruleLabel` below for details.

      • statement

        public WebAclRuleStatement statement()
        Returns:
        AWS WAF processing statement for the rule, for example `byteMatchStatement` or `geoMatchStatement`. See `statement` below for details.

      • visibilityConfig

        public WebAclRuleVisibilityConfig visibilityConfig()
        Returns:
        Amazon CloudWatch metrics and web request sample collection configuration. See `visibilityConfig` below for details.