Class RateBasedRule

Provides a WAF Rate Based Rule Resource

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var ipset = new Aws.WafRegional.IpSet("ipset", new Aws.WafRegional.IpSetArgs
    {
        IpSetDescriptors = 
        {
            new Aws.WafRegional.Inputs.IpSetIpSetDescriptorArgs
            {
                Type = "IPV4",
                Value = "192.0.7.0/24",
            },
        },
    });
    var wafrule = new Aws.WafRegional.RateBasedRule("wafrule", new Aws.WafRegional.RateBasedRuleArgs
    {
        MetricName = "tfWAFRule",
        Predicates = 
        {
            new Aws.WafRegional.Inputs.RateBasedRulePredicateArgs
            {
                DataId = ipset.Id,
                Negated = false,
                Type = "IPMatch",
            },
        },
        RateKey = "IP",
        RateLimit = 100,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

RateBasedRule

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.WafRegional

Assembly: Pulumi.Aws.dll

Syntax

public class RateBasedRule : CustomResource

Constructors

RateBasedRule(String, RateBasedRuleArgs, CustomResourceOptions)

Create a RateBasedRule resource with the given unique name, arguments, and options.

Declaration

public RateBasedRule(string name, RateBasedRuleArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
RateBasedRuleArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

The ARN of the WAF Regional Rate Based Rule.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

MetricName

The name or description for the Amazon CloudWatch metric of this rule.

Declaration

public Output<string> MetricName { get; }

Property Value

Type	Description
Output<System.String>

Name

The name or description of the rule.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Predicates

The objects to include in a rule (documented below).

Declaration

public Output<ImmutableArray<RateBasedRulePredicate>> Predicates { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<RateBasedRulePredicate>>

RateKey

Valid value is IP.

Declaration

public Output<string> RateKey { get; }

Property Value

Type	Description
Output<System.String>

RateLimit

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.

Declaration

public Output<int> RateLimit { get; }

Property Value

Type	Description
Output<System.Int32>

Tags

Key-value map of resource tags

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, RateBasedRuleState, CustomResourceOptions)

Get an existing RateBasedRule resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static RateBasedRule Get(string name, Input<string> id, RateBasedRuleState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
RateBasedRuleState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
RateBasedRule