pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin.inputs/SecurityPolicyRuleRateLimitOptionsArgs

SecurityPolicyRuleRateLimitOptionsArgs

data class SecurityPolicyRuleRateLimitOptionsArgs(val banDurationSec: Output<Int>? = null, val banThreshold: Output<SecurityPolicyRuleRateLimitOptionsBanThresholdArgs>? = null, val conformAction: Output<String>, val enforceOnKey: Output<String>? = null, val enforceOnKeyConfigs: Output<List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigArgs>>? = null, val enforceOnKeyName: Output<String>? = null, val exceedAction: Output<String>, val exceedRedirectOptions: Output<SecurityPolicyRuleRateLimitOptionsExceedRedirectOptionsArgs>? = null, val rateLimitThreshold: Output<SecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs>) : ConvertibleToJava<SecurityPolicyRuleRateLimitOptionsArgs>

Constructors

fun SecurityPolicyRuleRateLimitOptionsArgs(banDurationSec: Output<Int>? = null, banThreshold: Output<SecurityPolicyRuleRateLimitOptionsBanThresholdArgs>? = null, conformAction: Output<String>, enforceOnKey: Output<String>? = null, enforceOnKeyConfigs: Output<List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigArgs>>? = null, enforceOnKeyName: Output<String>? = null, exceedAction: Output<String>, exceedRedirectOptions: Output<SecurityPolicyRuleRateLimitOptionsExceedRedirectOptionsArgs>? = null, rateLimitThreshold: Output<SecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs>)

Functions

toJava

open override fun toJava(): SecurityPolicyRuleRateLimitOptionsArgs

Properties

banDurationSec

val banDurationSec: Output<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: Output<SecurityPolicyRuleRateLimitOptionsBanThresholdArgs>? = 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: Output<String>

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

enforceOnKey

val enforceOnKey: Output<String>? = null

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

enforceOnKeyConfigs

val enforceOnKeyConfigs: Output<List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigArgs>>? = 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: Output<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: Output<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: Output<SecurityPolicyRuleRateLimitOptionsExceedRedirectOptionsArgs>? = 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: Output<SecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs>

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