Class: Google::Apis::ComputeAlpha::SecurityPolicyRule

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.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 Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SecurityPolicyRule

Returns a new instance of SecurityPolicyRule.



41360
41361
41362
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41360

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#action ⇒ 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. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. Corresponds to the JSON property action

Returns:

  • (String) 


41241
41242
41243
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41241

def action
  @action
end

#description ⇒ String

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

Returns:

  • (String) 


41247
41248
41249
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41247

def description
  @description
end

#direction ⇒ String

The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL. Corresponds to the JSON property direction

Returns:

  • (String) 


41253
41254
41255
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41253

def direction
  @direction
end

#enable_logging ⇒ Boolean Also known as: enable_logging?

Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. This field may only be specified when the versioned_expr is set to FIREWALL. Corresponds to the JSON property enableLogging

Returns:

  • (Boolean) 


41262
41263
41264
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41262

def enable_logging
  @enable_logging
end

#header_action ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleHttpHeaderAction

Optional, additional actions that are performed on headers. Corresponds to the JSON property headerAction

Returns:



41268
41269
41270
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41268

def header_action
  @header_action
end

#kind ⇒ String

[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules Corresponds to the JSON property kind

Returns:

  • (String) 


41274
41275
41276
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41274

def kind
  @kind
end

#match ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleMatcher

Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. Corresponds to the JSON property match

Returns:



41280
41281
41282
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41280

def match
  @match
end

#network_match ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleNetworkMatcher

Represents a match condition that incoming network traffic is evaluated against. Corresponds to the JSON property networkMatch

Returns:



41286
41287
41288
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41286

def network_match
  @network_match
end

#preconfigured_waf_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRulePreconfiguredWafConfig

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. Corresponds to the JSON property preconfiguredWafConfig

Returns:



41293
41294
41295
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41293

def preconfigured_waf_config
  @preconfigured_waf_config
end

#preview ⇒ Boolean Also known as: preview?

If set to true, the specified action is not enforced. Corresponds to the JSON property preview

Returns:

  • (Boolean) 


41298
41299
41300
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41298

def preview
  @preview
end

#priority ⇒ Fixnum

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. Corresponds to the JSON property priority

Returns:

  • (Fixnum) 


41307
41308
41309
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41307

def priority
  @priority
end

#rate_limit_options ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleRateLimitOptions

Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions. Corresponds to the JSON property rateLimitOptions

Returns:



41313
41314
41315
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41313

def rate_limit_options
  @rate_limit_options
end

#redirect_options ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleRedirectOptions

Parameters defining the redirect action. Cannot be specified for any other actions. Corresponds to the JSON property redirectOptions

Returns:



41319
41320
41321
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41319

def redirect_options
  @redirect_options
end

#redirect_target ⇒ String

This must be specified for redirect actions. Cannot be specified for any other actions. Corresponds to the JSON property redirectTarget

Returns:

  • (String) 


41325
41326
41327
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41325

def redirect_target
  @redirect_target
end

#rule_managed_protection_tier ⇒ String

[Output Only] The minimum managed protection tier required for this rule. [ Deprecated] Use requiredManagedProtectionTiers instead. Corresponds to the JSON property ruleManagedProtectionTier

Returns:

  • (String) 


41331
41332
41333
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41331

def rule_managed_protection_tier
  @rule_managed_protection_tier
end

#rule_number ⇒ Fixnum

Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server. Corresponds to the JSON property ruleNumber

Returns:

  • (Fixnum) 


41338
41339
41340
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41338

def rule_number
  @rule_number
end

#rule_tuple_count ⇒ Fixnum

[Output Only] Calculation of the complexity of a single firewall security policy rule. Corresponds to the JSON property ruleTupleCount

Returns:

  • (Fixnum) 


41344
41345
41346
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41344

def rule_tuple_count
  @rule_tuple_count
end

#target_resources ⇒ Array<String>

A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL. Corresponds to the JSON property targetResources

Returns:

  • (Array<String>) 


41352
41353
41354
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41352

def target_resources
  @target_resources
end

#target_service_accounts ⇒ Array<String>

A list of service accounts indicating the sets of instances that are applied with this rule. Corresponds to the JSON property targetServiceAccounts

Returns:

  • (Array<String>) 


41358
41359
41360
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41358

def target_service_accounts
  @target_service_accounts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



41365
41366
41367
41368
41369
41370
41371
41372
41373
41374
41375
41376
41377
41378
41379
41380
41381
41382
41383
41384
41385
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 41365

def update!(**args)
  @action = args[:action] if args.key?(:action)
  @description = args[:description] if args.key?(:description)
  @direction = args[:direction] if args.key?(:direction)
  @enable_logging = args[:enable_logging] if args.key?(:enable_logging)
  @header_action = args[:header_action] if args.key?(:header_action)
  @kind = args[:kind] if args.key?(:kind)
  @match = args[:match] if args.key?(:match)
  @network_match = args[:network_match] if args.key?(:network_match)
  @preconfigured_waf_config = args[:preconfigured_waf_config] if args.key?(:preconfigured_waf_config)
  @preview = args[:preview] if args.key?(:preview)
  @priority = args[:priority] if args.key?(:priority)
  @rate_limit_options = args[:rate_limit_options] if args.key?(:rate_limit_options)
  @redirect_options = args[:redirect_options] if args.key?(:redirect_options)
  @redirect_target = args[:redirect_target] if args.key?(:redirect_target)
  @rule_managed_protection_tier = args[:rule_managed_protection_tier] if args.key?(:rule_managed_protection_tier)
  @rule_number = args[:rule_number] if args.key?(:rule_number)
  @rule_tuple_count = args[:rule_tuple_count] if args.key?(:rule_tuple_count)
  @target_resources = args[:target_resources] if args.key?(:target_resources)
  @target_service_accounts = args[:target_service_accounts] if args.key?(:target_service_accounts)
end