Package com.pulumi.aws.waf

Class RuleGroup

  • public class RuleGroup
extends com.pulumi.resources.CustomResource
    Provides a WAF Rule Group Resource ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.waf.Rule;
 import com.pulumi.aws.waf.RuleArgs;
 import com.pulumi.aws.waf.RuleGroup;
 import com.pulumi.aws.waf.RuleGroupArgs;
 import com.pulumi.aws.waf.inputs.RuleGroupActivatedRuleArgs;
 import com.pulumi.aws.waf.inputs.RuleGroupActivatedRuleActionArgs;
 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 example = new Rule("example", RuleArgs.builder()
             .name("example")
             .metricName("example")
             .build());
 
         var exampleRuleGroup = new RuleGroup("exampleRuleGroup", RuleGroupArgs.builder()
             .activatedRules(RuleGroupActivatedRuleArgs.builder()
                 .action(RuleGroupActivatedRuleActionArgs.builder()
                     .type("COUNT")
                     .build())
                 .priority(50)
                 .ruleId(example.id())
                 .build())
             .name("example")
             .metricName("example")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import WAF Rule Group using the ID. For example: ```sh $ pulumi import aws:waf/ruleGroup:RuleGroup example 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
      RuleGroup​(java.lang.String name)  
      RuleGroup​(java.lang.String name, RuleGroupArgs args)  
      RuleGroup​(java.lang.String name, RuleGroupArgs 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.util.Optional<java.util.List<RuleGroupActivatedRule>>> activatedRules()  
      com.pulumi.core.Output<java.lang.String> arn()  
      static RuleGroup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RuleGroupState 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.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

      • RuleGroup

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

      • RuleGroup

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

      • RuleGroup

        public RuleGroup​(java.lang.String name,
                 RuleGroupArgs 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

      • activatedRules

        public com.pulumi.core.Output<java.util.Optional<java.util.List<RuleGroupActivatedRule>>> activatedRules()
        Returns:
        A list of activated rules, see below

      • arn

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

      • metricName

        public com.pulumi.core.Output<java.lang.String> metricName()
        Returns:
        A friendly name for the metrics from the rule group

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the rule group. If omitted, the provider will assign a random, unique name. Conflicts with `namePrefix`.

      • 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 RuleGroup get​(java.lang.String name,
                            com.pulumi.core.Output<java.lang.String> id,
                            @Nullable
                            RuleGroupState 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.