Class RateLimitState

Inheritance
System.Object
InputArgs
ResourceArgs
RateLimitState
Inherited Members
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.Cloudflare
Assembly: Pulumi.Cloudflare.dll
Syntax
public sealed class RateLimitState : ResourceArgs

Constructors

View Source

RateLimitState()

Declaration
public RateLimitState()

Properties

View Source

Action

The action to be performed when the threshold of matched traffic within the period defined is exceeded.

Declaration
public Input<RateLimitActionGetArgs> Action { get; set; }
Property Value
Type Description
Input<RateLimitActionGetArgs>
View Source

BypassUrlPatterns

URLs matching the patterns specified here will be excluded from rate limiting.

Declaration
public InputList<string> BypassUrlPatterns { get; set; }
Property Value
Type Description
InputList<System.String>
View Source

Correlate

Determines how rate limiting is applied. By default if not specified, rate limiting applies to the clients IP address.

Declaration
public Input<RateLimitCorrelateGetArgs> Correlate { get; set; }
Property Value
Type Description
Input<RateLimitCorrelateGetArgs>
View Source

Description

A note that you can use to describe the reason for a rate limit. This value is sanitized and all tags are removed.

Declaration
public Input<string> Description { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Disabled

Whether this ratelimit is currently disabled. Default: false.

Declaration
public Input<bool> Disabled { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

Match

Determines which traffic the rate limit counts towards the threshold. By default matches all traffic in the zone. See definition below.

Declaration
public Input<RateLimitMatchGetArgs> Match { get; set; }
Property Value
Type Description
Input<RateLimitMatchGetArgs>
View Source

Period

The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed (min: 1, max: 86,400).

Declaration
public Input<int> Period { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

Threshold

The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period (min: 2, max: 1,000,000).

Declaration
public Input<int> Threshold { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

ZoneId

The DNS zone ID to apply rate limiting to.

Declaration
public Input<string> ZoneId { get; set; }
Property Value
Type Description
Input<System.String>