Package com.pulumi.aws.wafregional

Class RateBasedRule

  • public class RateBasedRule
extends com.pulumi.resources.CustomResource
    Provides a WAF Rate Based Rule Resource ## Example Usage 
     
 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.RateBasedRule;
 import com.pulumi.aws.wafregional.RateBasedRuleArgs;
 import com.pulumi.aws.wafregional.inputs.RateBasedRulePredicateArgs;
 import com.pulumi.resources.CustomResourceOptions;
 import java.util.ArrayList;
 import java.util.Arrays;
 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()
             .ipSetDescriptors(IpSetIpSetDescriptorArgs.builder()
                 .type("IPV4")
                 .value("192.0.7.0/24")
                 .build())
             .name("tfIPSet")
             .build());
 
         var wafrule = new RateBasedRule("wafrule", RateBasedRuleArgs.builder()
             .predicates(RateBasedRulePredicateArgs.builder()
                 .dataId(ipset.id())
                 .negated(false)
                 .type("IPMatch")
                 .build())
             .name("tfWAFRule")
             .metricName("tfWAFRule")
             .rateKey("IP")
             .rateLimit(100)
             .build(), CustomResourceOptions.builder()
                 .dependsOn(ipset)
                 .build());
 
     }
 }
    ## Import Using `pulumi import`, import WAF Regional Rate Based Rule using the ID. For example: ```sh $ pulumi import aws:wafregional/rateBasedRule:RateBasedRule 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      static RateBasedRule get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RateBasedRuleState 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<RateBasedRulePredicate>>> predicates()  
      com.pulumi.core.Output<java.lang.String> rateKey()  
      com.pulumi.core.Output<java.lang.Integer> rateLimit()  
      com.pulumi.core.Output<java.lang.String> region()  
      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

      • RateBasedRule

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

      • RateBasedRule

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

      • RateBasedRule

        public RateBasedRule​(java.lang.String name,
                     RateBasedRuleArgs 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 Rate Based 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<RateBasedRulePredicate>>> predicates()
        Returns:
        The objects to include in a rule (documented below).

      • rateKey

        public com.pulumi.core.Output<java.lang.String> rateKey()
        Returns:
        Valid value is IP.

      • rateLimit

        public com.pulumi.core.Output<java.lang.Integer> rateLimit()
        Returns:
        The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. Minimum value is 100.

      • region

        public 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.

      • 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 `defaultTags` 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 `defaultTags` configuration block.

      • get

        public static RateBasedRule get​(java.lang.String name,
                                com.pulumi.core.Output<java.lang.String> id,
                                @Nullable
                                RateBasedRuleState 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.