pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin.outputs/SecurityPolicyRuleRateLimitOptions

SecurityPolicyRuleRateLimitOptions

data class SecurityPolicyRuleRateLimitOptions(val banDurationSec: Int? = null, val banThreshold: SecurityPolicyRuleRateLimitOptionsBanThreshold? = null, val conformAction: String, val enforceOnKey: String? = null, val enforceOnKeyConfigs: List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>? = null, val enforceOnKeyName: String? = null, val exceedAction: String, val exceedRedirectOptions: SecurityPolicyRuleRateLimitOptionsExceedRedirectOptions? = null, val rateLimitThreshold: SecurityPolicyRuleRateLimitOptionsRateLimitThreshold)

Constructors

fun SecurityPolicyRuleRateLimitOptions(banDurationSec: Int? = null, banThreshold: SecurityPolicyRuleRateLimitOptionsBanThreshold? = null, conformAction: String, enforceOnKey: String? = null, enforceOnKeyConfigs: List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>? = null, enforceOnKeyName: String? = null, exceedAction: String, exceedRedirectOptions: SecurityPolicyRuleRateLimitOptionsExceedRedirectOptions? = null, rateLimitThreshold: SecurityPolicyRuleRateLimitOptionsRateLimitThreshold)

Types

Companion

object Companion

Properties

banDurationSec

val banDurationSec: Int? = null

Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.

banThreshold

val banThreshold: SecurityPolicyRuleRateLimitOptionsBanThreshold? = null

Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'. Structure is documented below.

conformAction

val conformAction: String

Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

enforceOnKey

val enforceOnKey: String? = null

Determines the key to enforce the rate_limit_threshold on. If not specified, defaults to "ALL".

enforceOnKeyConfigs

val enforceOnKeyConfigs: List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>? = null

) If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must be set to an empty string. Structure is documented below. Note: To avoid the conflict between enforce_on_key and enforce_on_key_configs, the field enforce_on_key needs to be set to an empty string.

enforceOnKeyName

val enforceOnKeyName: String? = null

Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.

exceedAction

val exceedAction: String

When a request is denied, returns the HTTP response code specified. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502.

exceedRedirectOptions

val exceedRedirectOptions: SecurityPolicyRuleRateLimitOptionsExceedRedirectOptions? = null

Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. Structure is documented below. The {ban/rate_limit}_threshold block supports:

rateLimitThreshold

val rateLimitThreshold: SecurityPolicyRuleRateLimitOptionsRateLimitThreshold

Threshold at which to begin ratelimiting. Structure is documented below.