Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. wafregional
  5. RateBasedRule
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

aws.wafregional.RateBasedRule

Explore with Pulumi AI

AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

Provides a WAF Rate Based Rule Resource

Example Usage

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

const ipset = new aws.wafregional.IpSet("ipset", {
    name: "tfIPSet",
    ipSetDescriptors: [{
        type: "IPV4",
        value: "192.0.7.0/24",
    }],
});
const wafrule = new aws.wafregional.RateBasedRule("wafrule", {
    name: "tfWAFRule",
    metricName: "tfWAFRule",
    rateKey: "IP",
    rateLimit: 100,
    predicates: [{
        dataId: ipset.id,
        negated: false,
        type: "IPMatch",
    }],
}, {
    dependsOn: [ipset],
});
Copy
import pulumi
import pulumi_aws as aws

ipset = aws.wafregional.IpSet("ipset",
    name="tfIPSet",
    ip_set_descriptors=[{
        "type": "IPV4",
        "value": "192.0.7.0/24",
    }])
wafrule = aws.wafregional.RateBasedRule("wafrule",
    name="tfWAFRule",
    metric_name="tfWAFRule",
    rate_key="IP",
    rate_limit=100,
    predicates=[{
        "data_id": ipset.id,
        "negated": False,
        "type": "IPMatch",
    }],
    opts = pulumi.ResourceOptions(depends_on=[ipset]))
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/wafregional"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ipset, err := wafregional.NewIpSet(ctx, "ipset", &wafregional.IpSetArgs{
			Name: pulumi.String("tfIPSet"),
			IpSetDescriptors: wafregional.IpSetIpSetDescriptorArray{
				&wafregional.IpSetIpSetDescriptorArgs{
					Type:  pulumi.String("IPV4"),
					Value: pulumi.String("192.0.7.0/24"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = wafregional.NewRateBasedRule(ctx, "wafrule", &wafregional.RateBasedRuleArgs{
			Name:       pulumi.String("tfWAFRule"),
			MetricName: pulumi.String("tfWAFRule"),
			RateKey:    pulumi.String("IP"),
			RateLimit:  pulumi.Int(100),
			Predicates: wafregional.RateBasedRulePredicateArray{
				&wafregional.RateBasedRulePredicateArgs{
					DataId:  ipset.ID(),
					Negated: pulumi.Bool(false),
					Type:    pulumi.String("IPMatch"),
				},
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			ipset,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var ipset = new Aws.WafRegional.IpSet("ipset", new()
    {
        Name = "tfIPSet",
        IpSetDescriptors = new[]
        {
            new Aws.WafRegional.Inputs.IpSetIpSetDescriptorArgs
            {
                Type = "IPV4",
                Value = "192.0.7.0/24",
            },
        },
    });

    var wafrule = new Aws.WafRegional.RateBasedRule("wafrule", new()
    {
        Name = "tfWAFRule",
        MetricName = "tfWAFRule",
        RateKey = "IP",
        RateLimit = 100,
        Predicates = new[]
        {
            new Aws.WafRegional.Inputs.RateBasedRulePredicateArgs
            {
                DataId = ipset.Id,
                Negated = false,
                Type = "IPMatch",
            },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            ipset,
        },
    });

});
Copy
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.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 ipset = new IpSet("ipset", IpSetArgs.builder()
            .name("tfIPSet")
            .ipSetDescriptors(IpSetIpSetDescriptorArgs.builder()
                .type("IPV4")
                .value("192.0.7.0/24")
                .build())
            .build());

        var wafrule = new RateBasedRule("wafrule", RateBasedRuleArgs.builder()
            .name("tfWAFRule")
            .metricName("tfWAFRule")
            .rateKey("IP")
            .rateLimit(100)
            .predicates(RateBasedRulePredicateArgs.builder()
                .dataId(ipset.id())
                .negated(false)
                .type("IPMatch")
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(ipset)
                .build());

    }
}
Copy
resources:
  ipset:
    type: aws:wafregional:IpSet
    properties:
      name: tfIPSet
      ipSetDescriptors:
        - type: IPV4
          value: 192.0.7.0/24
  wafrule:
    type: aws:wafregional:RateBasedRule
    properties:
      name: tfWAFRule
      metricName: tfWAFRule
      rateKey: IP
      rateLimit: 100
      predicates:
        - dataId: ${ipset.id}
          negated: false
          type: IPMatch
    options:
      dependsOn:
        - ${ipset}
Copy

Create RateBasedRule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new RateBasedRule(name: string, args: RateBasedRuleArgs, opts?: CustomResourceOptions);
@overload
def RateBasedRule(resource_name: str,
                  args: RateBasedRuleArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def RateBasedRule(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  metric_name: Optional[str] = None,
                  rate_key: Optional[str] = None,
                  rate_limit: Optional[int] = None,
                  name: Optional[str] = None,
                  predicates: Optional[Sequence[RateBasedRulePredicateArgs]] = None,
                  tags: Optional[Mapping[str, str]] = None)
func NewRateBasedRule(ctx *Context, name string, args RateBasedRuleArgs, opts ...ResourceOption) (*RateBasedRule, error)
public RateBasedRule(string name, RateBasedRuleArgs args, CustomResourceOptions? opts = null)
public RateBasedRule(String name, RateBasedRuleArgs args)
public RateBasedRule(String name, RateBasedRuleArgs args, CustomResourceOptions options)

type: aws:wafregional:RateBasedRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RateBasedRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RateBasedRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RateBasedRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RateBasedRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RateBasedRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var awsRateBasedRuleResource = new Aws.WafRegional.RateBasedRule("awsRateBasedRuleResource", new()
{
    MetricName = "string",
    RateKey = "string",
    RateLimit = 0,
    Name = "string",
    Predicates = new[]
    {
        new Aws.WafRegional.Inputs.RateBasedRulePredicateArgs
        {
            DataId = "string",
            Negated = false,
            Type = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := wafregional.NewRateBasedRule(ctx, "awsRateBasedRuleResource", &wafregional.RateBasedRuleArgs{
	MetricName: pulumi.String("string"),
	RateKey:    pulumi.String("string"),
	RateLimit:  pulumi.Int(0),
	Name:       pulumi.String("string"),
	Predicates: wafregional.RateBasedRulePredicateArray{
		&wafregional.RateBasedRulePredicateArgs{
			DataId:  pulumi.String("string"),
			Negated: pulumi.Bool(false),
			Type:    pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var awsRateBasedRuleResource = new RateBasedRule("awsRateBasedRuleResource", RateBasedRuleArgs.builder()
    .metricName("string")
    .rateKey("string")
    .rateLimit(0)
    .name("string")
    .predicates(RateBasedRulePredicateArgs.builder()
        .dataId("string")
        .negated(false)
        .type("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());
Copy
aws_rate_based_rule_resource = aws.wafregional.RateBasedRule("awsRateBasedRuleResource",
    metric_name="string",
    rate_key="string",
    rate_limit=0,
    name="string",
    predicates=[{
        "data_id": "string",
        "negated": False,
        "type": "string",
    }],
    tags={
        "string": "string",
    })
Copy
const awsRateBasedRuleResource = new aws.wafregional.RateBasedRule("awsRateBasedRuleResource", {
    metricName: "string",
    rateKey: "string",
    rateLimit: 0,
    name: "string",
    predicates: [{
        dataId: "string",
        negated: false,
        type: "string",
    }],
    tags: {
        string: "string",
    },
});
Copy
type: aws:wafregional:RateBasedRule
properties:
    metricName: string
    name: string
    predicates:
        - dataId: string
          negated: false
          type: string
    rateKey: string
    rateLimit: 0
    tags:
        string: string
Copy

RateBasedRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The RateBasedRule resource accepts the following input properties:

MetricName
This property is required.
Changes to this property will trigger replacement.
string
The name or description for the Amazon CloudWatch metric of this rule.
RateKey This property is required. string
Valid value is IP.
RateLimit This property is required. int
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.
Name Changes to this property will trigger replacement. string
The name or description of the rule.
Predicates List<RateBasedRulePredicate>
The objects to include in a rule (documented below).
Tags 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.
MetricName
This property is required.
Changes to this property will trigger replacement.
string
The name or description for the Amazon CloudWatch metric of this rule.
RateKey This property is required. string
Valid value is IP.
RateLimit This property is required. int
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.
Name Changes to this property will trigger replacement. string
The name or description of the rule.
Predicates []RateBasedRulePredicateArgs
The objects to include in a rule (documented below).
Tags 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.
metricName
This property is required.
Changes to this property will trigger replacement.
String
The name or description for the Amazon CloudWatch metric of this rule.
rateKey This property is required. String
Valid value is IP.
rateLimit This property is required. Integer
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.
name Changes to this property will trigger replacement. String
The name or description of the rule.
predicates List<RateBasedRulePredicate>
The objects to include in a rule (documented below).
tags 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.
metricName
This property is required.
Changes to this property will trigger replacement.
string
The name or description for the Amazon CloudWatch metric of this rule.
rateKey This property is required. string
Valid value is IP.
rateLimit This property is required. number
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.
name Changes to this property will trigger replacement. string
The name or description of the rule.
predicates RateBasedRulePredicate[]
The objects to include in a rule (documented below).
tags {[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
This property is required.
Changes to this property will trigger replacement.
str
The name or description for the Amazon CloudWatch metric of this rule.
rate_key This property is required. str
Valid value is IP.
rate_limit This property is required. int
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.
name Changes to this property will trigger replacement. str
The name or description of the rule.
predicates Sequence[RateBasedRulePredicateArgs]
The objects to include in a rule (documented below).
tags 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.
metricName
This property is required.
Changes to this property will trigger replacement.
String
The name or description for the Amazon CloudWatch metric of this rule.
rateKey This property is required. String
Valid value is IP.
rateLimit This property is required. Number
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.
name Changes to this property will trigger replacement. String
The name or description of the rule.
predicates List<Property Map>
The objects to include in a rule (documented below).
tags 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 RateBasedRule resource produces the following output properties:

Arn string
The ARN of the WAF Regional Rate Based Rule.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The ARN of the WAF Regional Rate Based Rule.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the WAF Regional Rate Based Rule.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The ARN of the WAF Regional Rate Based Rule.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The ARN of the WAF Regional Rate Based Rule.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the WAF Regional Rate Based Rule.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing RateBasedRule Resource

Get an existing RateBasedRule 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?: RateBasedRuleState, opts?: CustomResourceOptions): RateBasedRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        metric_name: Optional[str] = None,
        name: Optional[str] = None,
        predicates: Optional[Sequence[RateBasedRulePredicateArgs]] = None,
        rate_key: Optional[str] = None,
        rate_limit: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> RateBasedRule
func GetRateBasedRule(ctx *Context, name string, id IDInput, state *RateBasedRuleState, opts ...ResourceOption) (*RateBasedRule, error)
public static RateBasedRule Get(string name, Input<string> id, RateBasedRuleState? state, CustomResourceOptions? opts = null)
public static RateBasedRule get(String name, Output<String> id, RateBasedRuleState state, CustomResourceOptions options)
resources:  _:    type: aws:wafregional:RateBasedRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
Arn string
The ARN of the WAF Regional Rate Based Rule.
MetricName Changes to this property will trigger replacement. string
The name or description for the Amazon CloudWatch metric of this rule.
Name Changes to this property will trigger replacement. string
The name or description of the rule.
Predicates List<RateBasedRulePredicate>
The objects to include in a rule (documented below).
RateKey string
Valid value is IP.
RateLimit int
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.
Tags 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.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The ARN of the WAF Regional Rate Based Rule.
MetricName Changes to this property will trigger replacement. string
The name or description for the Amazon CloudWatch metric of this rule.
Name Changes to this property will trigger replacement. string
The name or description of the rule.
Predicates []RateBasedRulePredicateArgs
The objects to include in a rule (documented below).
RateKey string
Valid value is IP.
RateLimit int
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.
Tags 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.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the WAF Regional Rate Based Rule.
metricName Changes to this property will trigger replacement. String
The name or description for the Amazon CloudWatch metric of this rule.
name Changes to this property will trigger replacement. String
The name or description of the rule.
predicates List<RateBasedRulePredicate>
The objects to include in a rule (documented below).
rateKey String
Valid value is IP.
rateLimit Integer
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.
tags 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.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The ARN of the WAF Regional Rate Based Rule.
metricName Changes to this property will trigger replacement. string
The name or description for the Amazon CloudWatch metric of this rule.
name Changes to this property will trigger replacement. string
The name or description of the rule.
predicates RateBasedRulePredicate[]
The objects to include in a rule (documented below).
rateKey string
Valid value is IP.
rateLimit number
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.
tags {[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.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The ARN of the WAF Regional Rate Based Rule.
metric_name Changes to this property will trigger replacement. str
The name or description for the Amazon CloudWatch metric of this rule.
name Changes to this property will trigger replacement. str
The name or description of the rule.
predicates Sequence[RateBasedRulePredicateArgs]
The objects to include in a rule (documented below).
rate_key str
Valid value is IP.
rate_limit int
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.
tags 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.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the WAF Regional Rate Based Rule.
metricName Changes to this property will trigger replacement. String
The name or description for the Amazon CloudWatch metric of this rule.
name Changes to this property will trigger replacement. String
The name or description of the rule.
predicates List<Property Map>
The objects to include in a rule (documented below).
rateKey String
Valid value is IP.
rateLimit Number
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.
tags 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.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Supporting Types

RateBasedRulePredicate
, RateBasedRulePredicateArgs

DataId This property is required. string
A unique identifier for a predicate in the rule, such as Byte Match Set ID or IPSet ID.
Negated This property is required. bool
Set this to false if you want to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. If set to true, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.
Type This property is required. string
The type of predicate in a rule. Valid values: ByteMatch, GeoMatch, IPMatch, RegexMatch, SizeConstraint, SqlInjectionMatch, or XssMatch.
DataId This property is required. string
A unique identifier for a predicate in the rule, such as Byte Match Set ID or IPSet ID.
Negated This property is required. bool
Set this to false if you want to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. If set to true, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.
Type This property is required. string
The type of predicate in a rule. Valid values: ByteMatch, GeoMatch, IPMatch, RegexMatch, SizeConstraint, SqlInjectionMatch, or XssMatch.
dataId This property is required. String
A unique identifier for a predicate in the rule, such as Byte Match Set ID or IPSet ID.
negated This property is required. Boolean
Set this to false if you want to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. If set to true, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.
type This property is required. String
The type of predicate in a rule. Valid values: ByteMatch, GeoMatch, IPMatch, RegexMatch, SizeConstraint, SqlInjectionMatch, or XssMatch.
dataId This property is required. string
A unique identifier for a predicate in the rule, such as Byte Match Set ID or IPSet ID.
negated This property is required. boolean
Set this to false if you want to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. If set to true, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.
type This property is required. string
The type of predicate in a rule. Valid values: ByteMatch, GeoMatch, IPMatch, RegexMatch, SizeConstraint, SqlInjectionMatch, or XssMatch.
data_id This property is required. str
A unique identifier for a predicate in the rule, such as Byte Match Set ID or IPSet ID.
negated This property is required. bool
Set this to false if you want to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. If set to true, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.
type This property is required. str
The type of predicate in a rule. Valid values: ByteMatch, GeoMatch, IPMatch, RegexMatch, SizeConstraint, SqlInjectionMatch, or XssMatch.
dataId This property is required. String
A unique identifier for a predicate in the rule, such as Byte Match Set ID or IPSet ID.
negated This property is required. Boolean
Set this to false if you want to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. If set to true, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.
type This property is required. String
The type of predicate in a rule. Valid values: ByteMatch, GeoMatch, IPMatch, RegexMatch, SizeConstraint, SqlInjectionMatch, or XssMatch.

Import

Using pulumi import, import WAF Regional Rate Based Rule using the id. For example:

$ pulumi import aws:wafregional/rateBasedRule:RateBasedRule wafrule a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws