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

GetSecurityPolicyRuleRateLimitOption

data class GetSecurityPolicyRuleRateLimitOption(val banDurationSec: Int, val banThresholds: List<GetSecurityPolicyRuleRateLimitOptionBanThreshold>, val conformAction: String, val enforceOnKey: String, val enforceOnKeyConfigs: List<GetSecurityPolicyRuleRateLimitOptionEnforceOnKeyConfig>, val enforceOnKeyName: String, val exceedAction: String, val exceedRedirectOptions: List<GetSecurityPolicyRuleRateLimitOptionExceedRedirectOption>, val rateLimitThresholds: List<GetSecurityPolicyRuleRateLimitOptionRateLimitThreshold>)

Constructors

constructor(banDurationSec: Int, banThresholds: List<GetSecurityPolicyRuleRateLimitOptionBanThreshold>, conformAction: String, enforceOnKey: String, enforceOnKeyConfigs: List<GetSecurityPolicyRuleRateLimitOptionEnforceOnKeyConfig>, enforceOnKeyName: String, exceedAction: String, exceedRedirectOptions: List<GetSecurityPolicyRuleRateLimitOptionExceedRedirectOption>, rateLimitThresholds: List<GetSecurityPolicyRuleRateLimitOptionRateLimitThreshold>)

Types

Companion

object Companion

Properties

banDurationSec

val banDurationSec: Int

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.

banThresholds

val banThresholds: List<GetSecurityPolicyRuleRateLimitOptionBanThreshold>

Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'banDurationSec' when the number of requests that exceed the 'rateLimitThreshold' also exceed this 'banThreshold'.

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

Determines the key to enforce the rateLimitThreshold on

enforceOnKeyConfigs

val enforceOnKeyConfigs: List<GetSecurityPolicyRuleRateLimitOptionEnforceOnKeyConfig>

Enforce On Key Config of this security policy

enforceOnKeyName

val enforceOnKeyName: String

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

Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502, and "redirect" where the redirect parameters come from exceedRedirectOptions below.

exceedRedirectOptions

val exceedRedirectOptions: List<GetSecurityPolicyRuleRateLimitOptionExceedRedirectOption>

Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect.

rateLimitThresholds

val rateLimitThresholds: List<GetSecurityPolicyRuleRateLimitOptionRateLimitThreshold>

Threshold at which to begin ratelimiting.