pulumi-google-native-kotlin/com.pulumi.googlenative.compute.v1.kotlin.inputs/SecurityPolicyRuleArgs

SecurityPolicyRuleArgs

data class SecurityPolicyRuleArgs(val action: Output<String>? = null, val description: Output<String>? = null, val headerAction: Output<SecurityPolicyRuleHttpHeaderActionArgs>? = null, val match: Output<SecurityPolicyRuleMatcherArgs>? = null, val preconfiguredWafConfig: Output<SecurityPolicyRulePreconfiguredWafConfigArgs>? = null, val preview: Output<Boolean>? = null, val priority: Output<Int>? = null, val rateLimitOptions: Output<SecurityPolicyRuleRateLimitOptionsArgs>? = null, val redirectOptions: Output<SecurityPolicyRuleRedirectOptionsArgs>? = null) : ConvertibleToJava<SecurityPolicyRuleArgs>

Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

Constructors

fun SecurityPolicyRuleArgs(action: Output<String>? = null, description: Output<String>? = null, headerAction: Output<SecurityPolicyRuleHttpHeaderActionArgs>? = null, match: Output<SecurityPolicyRuleMatcherArgs>? = null, preconfiguredWafConfig: Output<SecurityPolicyRulePreconfiguredWafConfigArgs>? = null, preview: Output<Boolean>? = null, priority: Output<Int>? = null, rateLimitOptions: Output<SecurityPolicyRuleRateLimitOptionsArgs>? = null, redirectOptions: Output<SecurityPolicyRuleRedirectOptionsArgs>? = null)

Functions

toJava

open override fun toJava(): SecurityPolicyRuleArgs

Properties

action

val action: Output<String>? = null

The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for STATUS are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this.

description

val description: Output<String>? = null

An optional description of this resource. Provide this property when you create the resource.

headerAction

val headerAction: Output<SecurityPolicyRuleHttpHeaderActionArgs>? = null

Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

match

val match: Output<SecurityPolicyRuleMatcherArgs>? = null

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

preconfiguredWafConfig

val preconfiguredWafConfig: Output<SecurityPolicyRulePreconfiguredWafConfigArgs>? = null

Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.

preview

val preview: Output<Boolean>? = null

If set to true, the specified action is not enforced.

priority

val priority: Output<Int>? = null

An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.

rateLimitOptions

val rateLimitOptions: Output<SecurityPolicyRuleRateLimitOptionsArgs>? = null

Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.

redirectOptions

val redirectOptions: Output<SecurityPolicyRuleRedirectOptionsArgs>? = null

Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.