Class: Google::Cloud::Compute::V1::SecurityPolicyRule

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/compute/v1/compute.rb

Overview

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).

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



26065
26066
26067
26068
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26065

class SecurityPolicyRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

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

Returns:

  • (::String) —

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



26065
26066
26067
26068
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26065

class SecurityPolicyRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#header_action ⇒ ::Google::Cloud::Compute::V1::SecurityPolicyRuleHttpHeaderAction

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

Returns:



26065
26066
26067
26068
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26065

class SecurityPolicyRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#kind ⇒ ::String

Returns [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules.

Returns:

  • (::String) —

    [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules



26065
26066
26067
26068
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26065

class SecurityPolicyRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#match ⇒ ::Google::Cloud::Compute::V1::SecurityPolicyRuleMatcher

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

Returns:



26065
26066
26067
26068
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26065

class SecurityPolicyRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#preconfigured_waf_config ⇒ ::Google::Cloud::Compute::V1::SecurityPolicyRulePreconfiguredWafConfig

Returns 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.

Returns:



26065
26066
26067
26068
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26065

class SecurityPolicyRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#preview ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

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



26065
26066
26067
26068
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26065

class SecurityPolicyRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#priority ⇒ ::Integer

Returns 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.

Returns:

  • (::Integer) —

    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.



26065
26066
26067
26068
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26065

class SecurityPolicyRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#rate_limit_options ⇒ ::Google::Cloud::Compute::V1::SecurityPolicyRuleRateLimitOptions

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

Returns:



26065
26066
26067
26068
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26065

class SecurityPolicyRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#redirect_options ⇒ ::Google::Cloud::Compute::V1::SecurityPolicyRuleRedirectOptions

Returns 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.

Returns:



26065
26066
26067
26068
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26065

class SecurityPolicyRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end