Try AWS Native preview for resources not in the classic version.
aws.waf.RuleGroup
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides a WAF Rule Group Resource
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleRule = new Aws.Waf.Rule("exampleRule", new()
{
MetricName = "example",
});
var exampleRuleGroup = new Aws.Waf.RuleGroup("exampleRuleGroup", new()
{
MetricName = "example",
ActivatedRules = new[]
{
new Aws.Waf.Inputs.RuleGroupActivatedRuleArgs
{
Action = new Aws.Waf.Inputs.RuleGroupActivatedRuleActionArgs
{
Type = "COUNT",
},
Priority = 50,
RuleId = exampleRule.Id,
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/waf"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleRule, err := waf.NewRule(ctx, "exampleRule", &waf.RuleArgs{
MetricName: pulumi.String("example"),
})
if err != nil {
return err
}
_, err = waf.NewRuleGroup(ctx, "exampleRuleGroup", &waf.RuleGroupArgs{
MetricName: pulumi.String("example"),
ActivatedRules: waf.RuleGroupActivatedRuleArray{
&waf.RuleGroupActivatedRuleArgs{
Action: &waf.RuleGroupActivatedRuleActionArgs{
Type: pulumi.String("COUNT"),
},
Priority: pulumi.Int(50),
RuleId: exampleRule.ID(),
},
},
})
if err != nil {
return err
}
return nil
})
}
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.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 exampleRule = new Rule("exampleRule", RuleArgs.builder()
.metricName("example")
.build());
var exampleRuleGroup = new RuleGroup("exampleRuleGroup", RuleGroupArgs.builder()
.metricName("example")
.activatedRules(RuleGroupActivatedRuleArgs.builder()
.action(RuleGroupActivatedRuleActionArgs.builder()
.type("COUNT")
.build())
.priority(50)
.ruleId(exampleRule.id())
.build())
.build());
}
}
import pulumi
import pulumi_aws as aws
example_rule = aws.waf.Rule("exampleRule", metric_name="example")
example_rule_group = aws.waf.RuleGroup("exampleRuleGroup",
metric_name="example",
activated_rules=[aws.waf.RuleGroupActivatedRuleArgs(
action=aws.waf.RuleGroupActivatedRuleActionArgs(
type="COUNT",
),
priority=50,
rule_id=example_rule.id,
)])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleRule = new aws.waf.Rule("exampleRule", {metricName: "example"});
const exampleRuleGroup = new aws.waf.RuleGroup("exampleRuleGroup", {
metricName: "example",
activatedRules: [{
action: {
type: "COUNT",
},
priority: 50,
ruleId: exampleRule.id,
}],
});
resources:
exampleRule:
type: aws:waf:Rule
properties:
metricName: example
exampleRuleGroup:
type: aws:waf:RuleGroup
properties:
metricName: example
activatedRules:
- action:
type: COUNT
priority: 50
ruleId: ${exampleRule.id}
Create RuleGroup Resource
new RuleGroup(name: string, args: RuleGroupArgs, opts?: CustomResourceOptions);
@overload
def RuleGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
activated_rules: Optional[Sequence[RuleGroupActivatedRuleArgs]] = None,
metric_name: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
@overload
def RuleGroup(resource_name: str,
args: RuleGroupArgs,
opts: Optional[ResourceOptions] = None)
func NewRuleGroup(ctx *Context, name string, args RuleGroupArgs, opts ...ResourceOption) (*RuleGroup, error)
public RuleGroup(string name, RuleGroupArgs args, CustomResourceOptions? opts = null)
public RuleGroup(String name, RuleGroupArgs args)
public RuleGroup(String name, RuleGroupArgs args, CustomResourceOptions options)
type: aws:waf:RuleGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RuleGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args RuleGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args RuleGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RuleGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RuleGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
RuleGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The RuleGroup resource accepts the following input properties:
- Metric
Name string A friendly name for the metrics from the rule group
- Activated
Rules List<RuleGroup Activated Rule Args> A list of activated rules, see below
- Name string
A friendly name of the rule group
- Dictionary<string, string>
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.
- Metric
Name string A friendly name for the metrics from the rule group
- Activated
Rules []RuleGroup Activated Rule Args A list of activated rules, see below
- Name string
A friendly name of the rule group
- map[string]string
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.
- metric
Name String A friendly name for the metrics from the rule group
- activated
Rules List<RuleGroup Activated Rule Args> A list of activated rules, see below
- name String
A friendly name of the rule group
- Map<String,String>
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.
- metric
Name string A friendly name for the metrics from the rule group
- activated
Rules RuleGroup Activated Rule Args[] A list of activated rules, see below
- name string
A friendly name of the rule group
- {[key: string]: string}
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.
- metric_
name str A friendly name for the metrics from the rule group
- activated_
rules Sequence[RuleGroup Activated Rule Args] A list of activated rules, see below
- name str
A friendly name of the rule group
- Mapping[str, str]
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.
- metric
Name String A friendly name for the metrics from the rule group
- activated
Rules List<Property Map> A list of activated rules, see below
- name String
A friendly name of the rule group
- Map<String>
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.
Outputs
All input properties are implicitly available as output properties. Additionally, the RuleGroup resource produces the following output properties:
Look up Existing RuleGroup Resource
Get an existing RuleGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: RuleGroupState, opts?: CustomResourceOptions): RuleGroup
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
activated_rules: Optional[Sequence[RuleGroupActivatedRuleArgs]] = None,
arn: Optional[str] = None,
metric_name: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> RuleGroup
func GetRuleGroup(ctx *Context, name string, id IDInput, state *RuleGroupState, opts ...ResourceOption) (*RuleGroup, error)
public static RuleGroup Get(string name, Input<string> id, RuleGroupState? state, CustomResourceOptions? opts = null)
public static RuleGroup get(String name, Output<String> id, RuleGroupState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Activated
Rules List<RuleGroup Activated Rule Args> A list of activated rules, see below
- Arn string
The ARN of the WAF rule group.
- Metric
Name string A friendly name for the metrics from the rule group
- Name string
A friendly name of the rule group
- Dictionary<string, string>
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.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Activated
Rules []RuleGroup Activated Rule Args A list of activated rules, see below
- Arn string
The ARN of the WAF rule group.
- Metric
Name string A friendly name for the metrics from the rule group
- Name string
A friendly name of the rule group
- map[string]string
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.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- activated
Rules List<RuleGroup Activated Rule Args> A list of activated rules, see below
- arn String
The ARN of the WAF rule group.
- metric
Name String A friendly name for the metrics from the rule group
- name String
A friendly name of the rule group
- Map<String,String>
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.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- activated
Rules RuleGroup Activated Rule Args[] A list of activated rules, see below
- arn string
The ARN of the WAF rule group.
- metric
Name string A friendly name for the metrics from the rule group
- name string
A friendly name of the rule group
- {[key: string]: string}
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.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- activated_
rules Sequence[RuleGroup Activated Rule Args] A list of activated rules, see below
- arn str
The ARN of the WAF rule group.
- metric_
name str A friendly name for the metrics from the rule group
- name str
A friendly name of the rule group
- Mapping[str, str]
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.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- activated
Rules List<Property Map> A list of activated rules, see below
- arn String
The ARN of the WAF rule group.
- metric
Name String A friendly name for the metrics from the rule group
- name String
A friendly name of the rule group
- Map<String>
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.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Supporting Types
RuleGroupActivatedRule
- Action
Rule
Group Activated Rule Action Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the rule.
- Priority int
Specifies the order in which the rules are evaluated. Rules with a lower value are evaluated before rules with a higher value.
- Rule
Id string The ID of a rule
- Type string
e.g.,
BLOCK
,ALLOW
, orCOUNT
- Action
Rule
Group Activated Rule Action Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the rule.
- Priority int
Specifies the order in which the rules are evaluated. Rules with a lower value are evaluated before rules with a higher value.
- Rule
Id string The ID of a rule
- Type string
e.g.,
BLOCK
,ALLOW
, orCOUNT
- action
Rule
Group Activated Rule Action Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the rule.
- priority Integer
Specifies the order in which the rules are evaluated. Rules with a lower value are evaluated before rules with a higher value.
- rule
Id String The ID of a rule
- type String
e.g.,
BLOCK
,ALLOW
, orCOUNT
- action
Rule
Group Activated Rule Action Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the rule.
- priority number
Specifies the order in which the rules are evaluated. Rules with a lower value are evaluated before rules with a higher value.
- rule
Id string The ID of a rule
- type string
e.g.,
BLOCK
,ALLOW
, orCOUNT
- action
Rule
Group Activated Rule Action Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the rule.
- priority int
Specifies the order in which the rules are evaluated. Rules with a lower value are evaluated before rules with a higher value.
- rule_
id str The ID of a rule
- type str
e.g.,
BLOCK
,ALLOW
, orCOUNT
- action Property Map
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the rule.
- priority Number
Specifies the order in which the rules are evaluated. Rules with a lower value are evaluated before rules with a higher value.
- rule
Id String The ID of a rule
- type String
e.g.,
BLOCK
,ALLOW
, orCOUNT
RuleGroupActivatedRuleAction
- Type string
e.g.,
BLOCK
,ALLOW
, orCOUNT
- Type string
e.g.,
BLOCK
,ALLOW
, orCOUNT
- type String
e.g.,
BLOCK
,ALLOW
, orCOUNT
- type string
e.g.,
BLOCK
,ALLOW
, orCOUNT
- type str
e.g.,
BLOCK
,ALLOW
, orCOUNT
- type String
e.g.,
BLOCK
,ALLOW
, orCOUNT
Import
WAF Rule Group can be imported using the id, e.g.,
$ pulumi import aws:waf/ruleGroup:RuleGroup example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.