Rule class
Provides a WAF Rule Resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const ipset = new aws.waf.IpSet("ipset", {
ipSetDescriptors: [{
type: "IPV4",
value: "192.0.7.0/24",
}],
name: "tfIPSet",
});
const wafrule = new aws.waf.Rule("wafrule", {
predicates: [{
dataId: ipset.id,
negated: false,
type: "IPMatch",
}],
name: "tfWAFRule",
metricName: "tfWAFRule",
}, {
dependsOn: [ipset],
});
import pulumi
import pulumi_aws as aws
ipset = aws.waf.IpSet("ipset",
ip_set_descriptors=[{
"type": "IPV4",
"value": "192.0.7.0/24",
}],
name="tfIPSet")
wafrule = aws.waf.Rule("wafrule",
predicates=[{
"data_id": ipset.id,
"negated": False,
"type": "IPMatch",
}],
name="tfWAFRule",
metric_name="tfWAFRule",
opts = pulumi.ResourceOptions(depends_on=[ipset]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var ipset = new Aws.Waf.IpSet("ipset", new()
{
IpSetDescriptors = new[]
{
new Aws.Waf.Inputs.IpSetIpSetDescriptorArgs
{
Type = "IPV4",
Value = "192.0.7.0/24",
},
},
Name = "tfIPSet",
});
var wafrule = new Aws.Waf.Rule("wafrule", new()
{
Predicates = new[]
{
new Aws.Waf.Inputs.RulePredicateArgs
{
DataId = ipset.Id,
Negated = false,
Type = "IPMatch",
},
},
Name = "tfWAFRule",
MetricName = "tfWAFRule",
}, new CustomResourceOptions
{
DependsOn =
{
ipset,
},
});
});
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 {
ipset, err := waf.NewIpSet(ctx, "ipset", &waf.IpSetArgs{
IpSetDescriptors: waf.IpSetIpSetDescriptorArray{
&waf.IpSetIpSetDescriptorArgs{
Type: pulumi.String("IPV4"),
Value: pulumi.String("192.0.7.0/24"),
},
},
Name: pulumi.String("tfIPSet"),
})
if err != nil {
return err
}
_, err = waf.NewRule(ctx, "wafrule", &waf.RuleArgs{
Predicates: waf.RulePredicateArray{
&waf.RulePredicateArgs{
DataId: ipset.ID().ToIDOutput().ToStringOutput(),
Negated: pulumi.Bool(false),
Type: pulumi.String("IPMatch"),
},
},
Name: pulumi.String("tfWAFRule"),
MetricName: pulumi.String("tfWAFRule"),
}, pulumi.DependsOn([]pulumi.Resource{
ipset,
}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_waf_ipset" "ipset" {
ip_set_descriptors {
type = "IPV4"
value = "192.0.7.0/24"
}
name = "tfIPSet"
}
resource "aws_waf_rule" "wafrule" {
depends_on = [aws_waf_ipset.ipset]
predicates {
data_id = aws_waf_ipset.ipset.id
negated = false
type = "IPMatch"
}
name = "tfWAFRule"
metric_name = "tfWAFRule"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.waf.IpSet;
import com.pulumi.aws.waf.IpSetArgs;
import com.pulumi.aws.waf.inputs.IpSetIpSetDescriptorArgs;
import com.pulumi.aws.waf.Rule;
import com.pulumi.aws.waf.RuleArgs;
import com.pulumi.aws.waf.inputs.RulePredicateArgs;
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 Rule("wafrule", RuleArgs.builder()
.predicates(RulePredicateArgs.builder()
.dataId(ipset.id())
.negated(false)
.type("IPMatch")
.build())
.name("tfWAFRule")
.metricName("tfWAFRule")
.build(), CustomResourceOptions.builder()
.dependsOn(ipset)
.build());
}
}
resources:
ipset:
type: aws:waf:IpSet
properties:
ipSetDescriptors:
- type: IPV4
value: 192.0.7.0/24
name: tfIPSet
wafrule:
type: aws:waf:Rule
properties:
predicates:
- dataId: ${ipset.id}
negated: false
type: IPMatch
name: tfWAFRule
metricName: tfWAFRule
options:
dependsOn:
- ${ipset}
Import
Using pulumi import, import WAF rules using the id. For example:
$ pulumi import aws:waf/rule:Rule example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc
Constructors
- Rule(String name, {RuleArgs? args, CustomResourceOptions? options})
-
Creates a new Rule.
nameThe Pulumi resource name.argsArguments used to configure this Rule. The set of arguments for Rule.optionsResource options controlling this resource's behavior. - Rule.reference(String urn)
- Creates a typed reference to an existing Rule resource.
Properties
-
arn
↔ Output<
String> -
The ARN of the WAF rule.
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> -
The name or description for the Amazon CloudWatch metric of this rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace.
latefinal
-
name
↔ Output<
String> -
The name or description of the rule.
latefinal
-
predicates
↔ Output<
List< RulePredicate> ?> -
The objects to include in a rule (documented below).
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value map of resource tags. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration 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