Class CfnRateBasedRuleProps

Properties for defining a CfnRateBasedRule.

Inheritance

object

CfnRateBasedRuleProps

Implements

ICfnRateBasedRuleProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.WAFRegional

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnRateBasedRuleProps : ICfnRateBasedRuleProps

Syntax (vb)

Public Class CfnRateBasedRuleProps Implements ICfnRateBasedRuleProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.WAFRegional;

             var cfnRateBasedRuleProps = new CfnRateBasedRuleProps {
                 MetricName = "metricName",
                 Name = "name",
                 RateKey = "rateKey",
                 RateLimit = 123,

                 // the properties below are optional
                 MatchPredicates = new [] { new PredicateProperty {
                     DataId = "dataId",
                     Negated = false,
                     Type = "type"
                 } }
             };

Synopsis

Constructors

CfnRateBasedRuleProps()

Properties for defining a CfnRateBasedRule.

Properties

MatchPredicates	The `Predicates` object contains one `Predicate` element for each `ByteMatchSet` , `IPSet` , or `SqlInjectionMatchSet>` object that you want to include in a `RateBasedRule` .
MetricName	A name for the metrics for a `RateBasedRule` .
Name	A friendly name or description for a `RateBasedRule` .
RateKey	The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring.
RateLimit	The maximum number of requests, which have an identical value in the field specified by the `RateKey` , allowed in a five-minute period.

Constructors

CfnRateBasedRuleProps()

Properties for defining a CfnRateBasedRule.

public CfnRateBasedRuleProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.WAFRegional;

             var cfnRateBasedRuleProps = new CfnRateBasedRuleProps {
                 MetricName = "metricName",
                 Name = "name",
                 RateKey = "rateKey",
                 RateLimit = 123,

                 // the properties below are optional
                 MatchPredicates = new [] { new PredicateProperty {
                     DataId = "dataId",
                     Negated = false,
                     Type = "type"
                 } }
             };

Properties

MatchPredicates

The Predicates object contains one Predicate element for each ByteMatchSet , IPSet , or SqlInjectionMatchSet> object that you want to include in a RateBasedRule .

public object? MatchPredicates { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-matchpredicates

MetricName

A name for the metrics for a RateBasedRule .

public string MetricName { get; set; }

Property Value

string

Remarks

The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF , including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-metricname

Name

A friendly name or description for a RateBasedRule .

public string Name { get; set; }

Property Value

string

Remarks

You can't change the name of a RateBasedRule after you create it.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-name

RateKey

The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring.

public string RateKey { get; set; }

Property Value

string

Remarks

The only valid value for RateKey is IP . IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-ratekey

RateLimit

The maximum number of requests, which have an identical value in the field specified by the RateKey , allowed in a five-minute period.

public double RateLimit { get; set; }

Property Value

double

Remarks

If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-ratelimit

Implements

ICfnRateBasedRuleProps