RuleGroup class

Provides a WAF Rule Group Resource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.waf.Rule("example", {
    name: "example",
    metricName: "example",
});
const exampleRuleGroup = new aws.waf.RuleGroup("example", {
    activatedRules: [{
        action: {
            type: "COUNT",
        },
        priority: 50,
        ruleId: example.id,
    }],
    name: "example",
    metricName: "example",
});
import pulumi
import pulumi_aws as aws

example = aws.waf.Rule("example",
    name="example",
    metric_name="example")
example_rule_group = aws.waf.RuleGroup("example",
    activated_rules=[{
        "action": {
            "type": "COUNT",
        },
        "priority": 50,
        "rule_id": example.id,
    }],
    name="example",
    metric_name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Waf.Rule("example", new()
    {
        Name = "example",
        MetricName = "example",
    });

    var exampleRuleGroup = new Aws.Waf.RuleGroup("example", new()
    {
        ActivatedRules = new[]
        {
            new Aws.Waf.Inputs.RuleGroupActivatedRuleArgs
            {
                Action = new Aws.Waf.Inputs.RuleGroupActivatedRuleActionArgs
                {
                    Type = "COUNT",
                },
                Priority = 50,
                RuleId = example.Id,
            },
        },
        Name = "example",
        MetricName = "example",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/waf"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := waf.NewRule(ctx, "example", &waf.RuleArgs{
			Name:       pulumi.String("example"),
			MetricName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = waf.NewRuleGroup(ctx, "example", &waf.RuleGroupArgs{
			ActivatedRules: waf.RuleGroupActivatedRuleArray{
				&waf.RuleGroupActivatedRuleArgs{
					Action: &waf.RuleGroupActivatedRuleActionArgs{
						Type: pulumi.String("COUNT"),
					},
					Priority: pulumi.Int(50),
					RuleId:   example.ID().ToIDOutput().ToStringOutput(),
				},
			},
			Name:       pulumi.String("example"),
			MetricName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_waf_rule" "example" {
  name        = "example"
  metric_name = "example"
}
resource "aws_waf_rulegroup" "example" {
  activated_rules {
    action = {
      type = "COUNT"
    }
    priority = 50
    rule_id  = aws_waf_rule.example.id
  }
  name        = "example"
  metric_name = "example"
}
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());

    }
}
resources:
  example:
    type: aws:waf:Rule
    properties:
      name: example
      metricName: example
  exampleRuleGroup:
    type: aws:waf:RuleGroup
    name: example
    properties:
      activatedRules:
        - action:
            type: COUNT
          priority: 50
          ruleId: ${example.id}
      name: example
      metricName: example

Import

Using pulumi import, import WAF Rule Group using the id. For example:

$ pulumi import aws:waf/ruleGroup:RuleGroup example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc

Constructors

RuleGroup(String name, {RuleGroupArgs? args, CustomResourceOptions? options})
Creates a new RuleGroup. name The Pulumi resource name. args Arguments used to configure this RuleGroup. The set of arguments for RuleGroup. options Resource options controlling this resource's behavior.
RuleGroup.reference(String urn)
Creates a typed reference to an existing RuleGroup resource.

Properties

activatedRules ↔ Output<List<RuleGroupActivatedRule>?>
A list of activated rules, see below
latefinal
arn ↔ Output<String>
The ARN of the WAF rule group.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
metricName ↔ Output<String>
A friendly name for the metrics from the rule group
latefinal
name ↔ Output<String>
Name of the rule group. If omitted, the provider will assign a random, unique name. Conflicts with namePrefix.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
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.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {RuleGroupState? state, CustomResourceOptions? options}) → RuleGroup
Gets an existing RuleGroup resource's state with the given name and id.