text: # coding=utf-8
  # *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
  # *** Do not edit by hand unless you're certain you know what you are doing! ***
  
  import warnings
  import pulumi
  import pulumi.runtime
  from typing import Any, Mapping, Optional, Sequence, Union
  from .. import _utilities, _tables
  from . import outputs
  from ._inputs import *
  
  __all__ = ['Rule']
  
  
  class Rule(pulumi.CustomResource):
      def __init__(__self__,
                   resource_name: str,
                   opts: Optional[pulumi.ResourceOptions] = None,
                   metric_name: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   predicates: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['RulePredicateArgs']]]]] = None,
                   tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                   __props__=None,
                   __name__=None,
                   __opts__=None):
          """
          Provides an WAF Regional Rule Resource for use with Application Load Balancer.
  
          ## Example Usage
  
          ```python
          import pulumi
          import pulumi_aws as aws
  
          ipset = aws.wafregional.IpSet("ipset", ip_set_descriptors=[aws.wafregional.IpSetIpSetDescriptorArgs(
              type="IPV4",
              value="192.0.7.0/24",
          )])
          wafrule = aws.wafregional.Rule("wafrule",
              metric_name="tfWAFRule",
              predicates=[aws.wafregional.RulePredicateArgs(
                  type="IPMatch",
                  data_id=ipset.id,
                  negated=False,
              )])
          ```
          ## Nested Fields
  
          ### `predicate`
  
          See the [WAF Documentation](https://docs.aws.amazon.com/waf/latest/APIReference/API_Predicate.html) for more information.
  
          #### Arguments
  
          * `type` - (Required) The type of predicate in a rule. Valid values: `ByteMatch`, `GeoMatch`, `IPMatch`, `RegexMatch`, `SizeConstraint`, `SqlInjectionMatch`, or `XssMatch`
          * `data_id` - (Required) The unique identifier of a predicate, such as the ID of a `ByteMatchSet` or `IPSet`.
          * `negated` - (Required) Whether to use the settings or the negated settings that you specified in the objects.
  
          :param str resource_name: The name of the resource.
          :param pulumi.ResourceOptions opts: Options for the resource.
          :param pulumi.Input[str] metric_name: The name or description for the Amazon CloudWatch metric of this rule.
          :param pulumi.Input[str] name: The name or description of the rule.
          :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['RulePredicateArgs']]]] predicates: The objects to include in a rule (documented below).
          :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: Key-value map of resource tags
          """
          if __name__ is not None:
              warnings.warn("explicit use of __name__ is deprecated", DeprecationWarning)
              resource_name = __name__
          if __opts__ is not None:
              warnings.warn("explicit use of __opts__ is deprecated, use 'opts' instead", DeprecationWarning)
              opts = __opts__
          if opts is None:
              opts = pulumi.ResourceOptions()
          if not isinstance(opts, pulumi.ResourceOptions):
              raise TypeError('Expected resource options to be a ResourceOptions instance')
          if opts.version is None:
              opts.version = _utilities.get_version()
          if opts.id is None:
              if __props__ is not None:
                  raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
              __props__ = dict()
  
              if metric_name is None:
                  raise TypeError("Missing required property 'metric_name'")
              __props__['metric_name'] = metric_name
              __props__['name'] = name
              __props__['predicates'] = predicates
              __props__['tags'] = tags
              __props__['arn'] = None
          super(Rule, __self__).__init__(
              'aws:wafregional/rule:Rule',
              resource_name,
              __props__,
              opts)
  
      @staticmethod
      def get(resource_name: str,
              id: pulumi.Input[str],
              opts: Optional[pulumi.ResourceOptions] = None,
              arn: Optional[pulumi.Input[str]] = None,
              metric_name: Optional[pulumi.Input[str]] = None,
              name: Optional[pulumi.Input[str]] = None,
              predicates: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['RulePredicateArgs']]]]] = None,
              tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None) -> 'Rule':
          """
          Get an existing Rule resource's state with the given name, id, and optional extra
          properties used to qualify the lookup.
  
          :param str resource_name: The unique name of the resulting resource.
          :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
          :param pulumi.ResourceOptions opts: Options for the resource.
          :param pulumi.Input[str] arn: The ARN of the WAF Regional Rule.
          :param pulumi.Input[str] metric_name: The name or description for the Amazon CloudWatch metric of this rule.
          :param pulumi.Input[str] name: The name or description of the rule.
          :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['RulePredicateArgs']]]] predicates: The objects to include in a rule (documented below).
          :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: Key-value map of resource tags
          """
          opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
  
          __props__ = dict()
  
          __props__["arn"] = arn
          __props__["metric_name"] = metric_name
          __props__["name"] = name
          __props__["predicates"] = predicates
          __props__["tags"] = tags
          return Rule(resource_name, opts=opts, __props__=__props__)
  
      @property
      @pulumi.getter
      def arn(self) -> pulumi.Output[str]:
          """
          The ARN of the WAF Regional Rule.
          """
          return pulumi.get(self, "arn")
  
      @property
      @pulumi.getter(name="metricName")
      def metric_name(self) -> pulumi.Output[str]:
          """
          The name or description for the Amazon CloudWatch metric of this rule.
          """
          return pulumi.get(self, "metric_name")
  
      @property
      @pulumi.getter
      def name(self) -> pulumi.Output[str]:
          """
          The name or description of the rule.
          """
          return pulumi.get(self, "name")
  
      @property
      @pulumi.getter
      def predicates(self) -> pulumi.Output[Optional[Sequence['outputs.RulePredicate']]]:
          """
          The objects to include in a rule (documented below).
          """
          return pulumi.get(self, "predicates")
  
      @property
      @pulumi.getter
      def tags(self) -> pulumi.Output[Optional[Mapping[str, str]]]:
          """
          Key-value map of resource tags
          """
          return pulumi.get(self, "tags")
  
      def translate_output_property(self, prop):
          return _tables.CAMEL_TO_SNAKE_CASE_TABLE.get(prop) or prop
  
      def translate_input_property(self, prop):
          return _tables.SNAKE_TO_CAMEL_CASE_TABLE.get(prop) or prop
  
  