Class: Google::Apis::ComputeAlpha::SecurityPolicyRule
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::SecurityPolicyRule
- 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
-
#action ⇒ String
The Action to perform when the rule is matched.
-
#description ⇒ String
An optional description of this resource.
-
#direction ⇒ String
The direction in which this rule applies.
-
#enable_logging ⇒ Boolean
(also: #enable_logging?)
Denotes whether to enable logging for a particular rule.
-
#header_action ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleHttpHeaderAction
Optional, additional actions that are performed on headers.
-
#kind ⇒ String
[Output only] Type of the resource.
-
#match ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleMatcher
Represents a match condition that incoming traffic is evaluated against.
-
#preview ⇒ Boolean
(also: #preview?)
If set to true, the specified action is not enforced.
-
#priority ⇒ Fixnum
An integer indicating the priority of a rule in the list.
-
#rate_limit_options ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleRateLimitOptions
Must be specified if the action is "rate_based_ban" or "throttle".
-
#redirect_options ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRuleRedirectOptions
Parameters defining the redirect action.
-
#redirect_target ⇒ String
This must be specified for redirect actions.
-
#rule_managed_protection_tier ⇒ String
[Output Only] The minimum managed protection tier required for this rule.
-
#rule_number ⇒ Fixnum
Identifier for the rule.
-
#rule_tuple_count ⇒ Fixnum
[Output Only] Calculation of the complexity of a single firewall security policy rule.
-
#target_resources ⇒ Array<String>
A list of network resource URLs to which this rule applies.
-
#target_service_accounts ⇒ Array<String>
A list of service accounts indicating the sets of instances that are applied with this rule.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SecurityPolicyRule
constructor
A new instance of SecurityPolicyRule.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ SecurityPolicyRule
Returns a new instance of SecurityPolicyRule.
38138 38139 38140 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38138 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
38033 38034 38035 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38033 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
38039 38040 38041 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38039 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
38045 38046 38047 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38045 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
38054 38055 38056 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38054 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
38060 38061 38062 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38060 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
38066 38067 38068 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38066 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
38072 38073 38074 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38072 def match @match end |
#preview ⇒ Boolean Also known as: preview?
If set to true, the specified action is not enforced.
Corresponds to the JSON property preview
38077 38078 38079 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38077 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
38086 38087 38088 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38086 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
38092 38093 38094 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38092 def @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
38098 38099 38100 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38098 def @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
38104 38105 38106 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38104 def redirect_target @redirect_target end |
#rule_managed_protection_tier ⇒ String
[Output Only] The minimum managed protection tier required for this rule.
Corresponds to the JSON property ruleManagedProtectionTier
38109 38110 38111 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38109 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
38116 38117 38118 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38116 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
38122 38123 38124 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38122 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
38130 38131 38132 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38130 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
38136 38137 38138 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38136 def target_service_accounts @target_service_accounts end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
38143 38144 38145 38146 38147 38148 38149 38150 38151 38152 38153 38154 38155 38156 38157 38158 38159 38160 38161 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38143 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) @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 |