Package com.pulumi.aws.wafregional

Class Rule

  • public class Rule
extends com.pulumi.resources.CustomResource
    Provides an WAF Regional Rule Resource for use with Application Load Balancer. ## Example Usage <!--Start PulumiCodeChooser --> 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.wafregional.IpSet;
 import com.pulumi.aws.wafregional.IpSetArgs;
 import com.pulumi.aws.wafregional.inputs.IpSetIpSetDescriptorArgs;
 import com.pulumi.aws.wafregional.Rule;
 import com.pulumi.aws.wafregional.RuleArgs;
 import com.pulumi.aws.wafregional.inputs.RulePredicateArgs;
 import java.util.List;
 import java.util.ArrayList;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var ipset = new IpSet("ipset", IpSetArgs.builder()        
             .name("tfIPSet")
             .ipSetDescriptors(IpSetIpSetDescriptorArgs.builder()
                 .type("IPV4")
                 .value("192.0.7.0/24")
                 .build())
             .build());
 
         var wafrule = new Rule("wafrule", RuleArgs.builder()        
             .name("tfWAFRule")
             .metricName("tfWAFRule")
             .predicates(RulePredicateArgs.builder()
                 .type("IPMatch")
                 .dataId(ipset.id())
                 .negated(false)
                 .build())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ## 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. ## Import Using `pulumi import`, import WAF Regional Rule using the id. For example: ```sh $ pulumi import aws:wafregional/rule:Rule wafrule a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Rule​(java.lang.String name)  
      Rule​(java.lang.String name, RuleArgs args)  
      Rule​(java.lang.String name, RuleArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      static Rule get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RuleState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> metricName()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<RulePredicate>>> predicates()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Rule

        public Rule​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Rule

        public Rule​(java.lang.String name,
            RuleArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Rule

        public Rule​(java.lang.String name,
            RuleArgs args,
            @Nullable
            com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN of the WAF Regional Rule.

      • metricName

        public com.pulumi.core.Output<java.lang.String> metricName()
        Returns:
        The name or description for the Amazon CloudWatch metric of this rule.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name or description of the rule.

      • predicates

        public com.pulumi.core.Output<java.util.Optional<java.util.List<RulePredicate>>> predicates()
        Returns:
        The objects to include in a rule (documented below).

      • tags

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

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

      • get

        public static Rule get​(java.lang.String name,
                       com.pulumi.core.Output<java.lang.String> id,
                       @Nullable
                       RuleState state,
                       @Nullable
                       com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.