Package com.pulumi.aws.wafv2

Class RuleGroupArgs

  • public final class RuleGroupArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • capacity

        public com.pulumi.core.Output<java.lang.Integer> capacity()
        Returns:
        Web ACL capacity units (WCUs) required for this rule group. See [here](https://docs.aws.amazon.com/waf/latest/APIReference/API_CreateRuleGroup.html#API_CreateRuleGroup_RequestSyntax) for general information and [here](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statements-list.html) for capacity specific information.

      • customResponseBodies

        public java.util.Optional<com.pulumi.core.Output<java.util.List<RuleGroupCustomResponseBodyArgs>>> customResponseBodies()
        Returns:
        Custom response bodies that can be referenced by `customResponse` actions. See Custom Response Body below for details.

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Friendly description of the rule group.

      • monetizationConfig

        public java.util.Optional<com.pulumi.core.Output<RuleGroupMonetizationConfigArgs>> monetizationConfig()
        Returns:
        Monetization configuration for the rule group. Required when any rule uses the `monetize` action. See `monetizationConfig` below for details.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Friendly name of the rule group.

      • namePrefix

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> namePrefix()
        Returns:
        Creates a unique name beginning with the specified prefix. Conflicts with `name`.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • rules

        public java.util.Optional<com.pulumi.core.Output<java.util.List<RuleGroupRuleArgs>>> rules()
        Returns:
        Rule blocks used to identify the web requests that you want to `allow`, `block`, or `count`. See Rules below for details.

      • rulesJson

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> rulesJson()
        Returns:
        Raw JSON string to allow more than three nested statements. Conflicts with `rule` attribute. This is for advanced use cases where more than 3 levels of nested statements are required. **There is no drift detection at this time**. If you use this attribute instead of `rule`, you will be foregoing drift detection. Additionally, importing an existing rule group into a configuration with `rulesJson` set will result in a one time in-place update as the remote rule configuration is initially written to the `rule` attribute. See the AWS [documentation](https://docs.aws.amazon.com/waf/latest/APIReference/API_CreateRuleGroup.html) for the JSON structure.

      • scope

        public com.pulumi.core.Output<java.lang.String> scope()
        Returns:
        Scope of the rule group, either an AWS CloudFront distribution or a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Array of key:value pairs to associate with the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • visibilityConfig

        public com.pulumi.core.Output<RuleGroupVisibilityConfigArgs> visibilityConfig()
        Returns:
        Amazon CloudWatch metrics and web request sample collection configuration. See Visibility Configuration below for details.