Class: Google::Apis::ComputeBeta::SecurityPolicyRule

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



34714
34715
34716
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34714

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(): deny access to target, returns the HTTP response code specified (valid values 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) 


34613
34614
34615
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34613

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) 


34619
34620
34621
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34619

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) 


34625
34626
34627
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34625

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) 


34634
34635
34636
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34634

def enable_logging
  @enable_logging
end

#header_action ⇒ Google::Apis::ComputeBeta::SecurityPolicyRuleHttpHeaderAction

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

Returns:



34640
34641
34642
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34640

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) 


34646
34647
34648
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34646

def kind
  @kind
end

#match ⇒ Google::Apis::ComputeBeta::SecurityPolicyRuleMatcher

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

Returns:



34652
34653
34654
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34652

def match
  @match
end

#preconfigured_waf_config ⇒ Google::Apis::ComputeBeta::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:



34659
34660
34661
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34659

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) 


34664
34665
34666
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34664

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) 


34673
34674
34675
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34673

def priority
  @priority
end

#rate_limit_options ⇒ Google::Apis::ComputeBeta::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:



34679
34680
34681
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34679

def rate_limit_options
  @rate_limit_options
end

#redirect_options ⇒ Google::Apis::ComputeBeta::SecurityPolicyRuleRedirectOptions

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

Returns:



34685
34686
34687
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34685

def redirect_options
  @redirect_options
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) 


34692
34693
34694
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34692

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) 


34698
34699
34700
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34698

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


34706
34707
34708
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34706

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


34712
34713
34714
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34712

def target_service_accounts
  @target_service_accounts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



34719
34720
34721
34722
34723
34724
34725
34726
34727
34728
34729
34730
34731
34732
34733
34734
34735
34736
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34719

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