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 enforceOnKeyName: Output<String>? = null, val exceedAction: Output<String>, val exceedRedirectOptions: Output<SecurityPolicyRuleRateLimitOptionsExceedRedirectOptionsArgs>? = null, val rateLimitThreshold: Output<SecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs>) : ConvertibleToJava<SecurityPolicyRuleRateLimitOptionsArgs>

Constructors

Link copied to clipboard
fun SecurityPolicyRuleRateLimitOptionsArgs(banDurationSec: Output<Int>? = null, banThreshold: Output<SecurityPolicyRuleRateLimitOptionsBanThresholdArgs>? = null, conformAction: Output<String>, enforceOnKey: Output<String>? = null, enforceOnKeyName: Output<String>? = null, exceedAction: Output<String>, exceedRedirectOptions: Output<SecurityPolicyRuleRateLimitOptionsExceedRedirectOptionsArgs>? = null, rateLimitThreshold: Output<SecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs>)

Functions

Link copied to clipboard
open override fun toJava(): SecurityPolicyRuleRateLimitOptionsArgs

Properties

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
val conformAction: Output<String>

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

Link copied to clipboard
val enforceOnKey: Output<String>? = null

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

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
val rateLimitThreshold: Output<SecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs>

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