pulumi-cloudflare-kotlin/com.pulumi.cloudflare.kotlin.outputs/GetRateLimitResult

GetRateLimitResult

data class GetRateLimitResult(val action: GetRateLimitAction, val bypasses: List<GetRateLimitBypass>, val description: String, val disabled: Boolean, val id: String, val match: GetRateLimitMatch, val period: Double, val rateLimitId: String? = null, val threshold: Double, val zoneId: String)

A collection of values returned by getRateLimit.

Constructors

GetRateLimitResult

constructor(action: GetRateLimitAction, bypasses: List<GetRateLimitBypass>, description: String, disabled: Boolean, id: String, match: GetRateLimitMatch, period: Double, rateLimitId: String? = null, threshold: Double, zoneId: String)

Types

Companion

object Companion

Properties

action

val action: GetRateLimitAction

The action to perform when the threshold of matched traffic within the configured period is exceeded.

bypasses

val bypasses: List<GetRateLimitBypass>

Criteria specifying when the current rate limit should be bypassed. You can specify that the rate limit should not apply to one or more URLs.

description

val description: String

An informative summary of the rate limit. This value is sanitized and any tags will be removed.

disabled

val disabled: Boolean

When true, indicates that the rate limit is currently disabled.

val id: String

The unique identifier of the rate limit.

match

val match: GetRateLimitMatch

Determines which traffic the rate limit counts towards the threshold.

period

val period: Double

The time in seconds (an integer value) to count matching traffic. If the count exceeds the configured threshold within this period, Cloudflare will perform the configured action.

rateLimitId

val rateLimitId: String? = null

The unique identifier of the rate limit.

threshold

val threshold: Double

The threshold that will trigger the configured mitigation action. Configure this value along with the period property to establish a threshold per period.

zoneId

val zoneId: String

Identifier