Class: Google::Apis::ComputeAlpha::Firewall
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Firewall
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb
Overview
Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.
Defined Under Namespace
Instance Attribute Summary collapse
-
#allowed ⇒ Array<Google::Apis::ComputeAlpha::Firewall::Allowed>
The list of ALLOW rules specified by this firewall.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#denied ⇒ Array<Google::Apis::ComputeAlpha::Firewall::Denied>
The list of DENY rules specified by this firewall.
-
#description ⇒ String
An optional description of this resource.
-
#destination_ranges ⇒ Array<String>
If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges.
-
#direction ⇒ String
Direction of traffic to which this firewall applies, either
INGRESS
orEGRESS
. -
#disabled ⇒ Boolean
(also: #disabled?)
Denotes whether the firewall rule is disabled.
-
#enable_logging ⇒ Boolean
(also: #enable_logging?)
Deprecated in favor of enable in LogConfig.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#log_config ⇒ Google::Apis::ComputeAlpha::FirewallLogConfig
The available logging options for a firewall rule.
-
#name ⇒ String
Name of the resource; provided by the client when the resource is created.
-
#network ⇒ String
URL of the network resource for this firewall rule.
-
#priority ⇒ Fixnum
Priority for this rule.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#source_ranges ⇒ Array<String>
If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges.
-
#source_service_accounts ⇒ Array<String>
If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list.
-
#source_tags ⇒ Array<String>
If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network.
-
#target_service_accounts ⇒ Array<String>
A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[].
-
#target_tags ⇒ Array<String>
A list of tags that controls which instances the firewall rule applies to.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Firewall
constructor
A new instance of Firewall.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Firewall
Returns a new instance of Firewall.
7244 7245 7246 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7244 def initialize(**args) update!(**args) end |
Instance Attribute Details
#allowed ⇒ Array<Google::Apis::ComputeAlpha::Firewall::Allowed>
The list of ALLOW rules specified by this firewall. Each rule specifies a
protocol and port-range tuple that describes a permitted connection.
Corresponds to the JSON property allowed
7076 7077 7078 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7076 def allowed @allowed end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
7081 7082 7083 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7081 def @creation_timestamp end |
#denied ⇒ Array<Google::Apis::ComputeAlpha::Firewall::Denied>
The list of DENY rules specified by this firewall. Each rule specifies a
protocol and port-range tuple that describes a denied connection.
Corresponds to the JSON property denied
7087 7088 7089 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7087 def denied @denied end |
#description ⇒ String
An optional description of this resource. Provide this field when you create
the resource.
Corresponds to the JSON property description
7093 7094 7095 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7093 def description @description end |
#destination_ranges ⇒ Array<String>
If destination ranges are specified, the firewall rule applies only to traffic
that has destination IP address in these ranges. These ranges must be
expressed in CIDR format. Only IPv4 is supported.
Corresponds to the JSON property destinationRanges
7100 7101 7102 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7100 def destination_ranges @destination_ranges end |
#direction ⇒ String
Direction of traffic to which this firewall applies, either INGRESS
or
EGRESS
. The default is INGRESS
. For INGRESS
traffic, you cannot specify
the destinationRanges field, and for EGRESS
traffic, you cannot specify the
sourceRanges or sourceTags fields.
Corresponds to the JSON property direction
7108 7109 7110 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7108 def direction @direction end |
#disabled ⇒ Boolean Also known as: disabled?
Denotes whether the firewall rule is disabled. When set to true, the firewall
rule is not enforced and the network behaves as if it did not exist. If this
is unspecified, the firewall rule will be enabled.
Corresponds to the JSON property disabled
7115 7116 7117 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7115 def disabled @disabled end |
#enable_logging ⇒ Boolean Also known as: enable_logging?
Deprecated in favor of enable in LogConfig. This field denotes whether to
enable logging for a particular firewall rule. If logging is enabled, logs
will be exported to Stackdriver.
Corresponds to the JSON property enableLogging
7123 7124 7125 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7123 def enable_logging @enable_logging end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
7130 7131 7132 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7130 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#firewall for firewall rules.
Corresponds to the JSON property kind
7135 7136 7137 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7135 def kind @kind end |
#log_config ⇒ Google::Apis::ComputeAlpha::FirewallLogConfig
The available logging options for a firewall rule.
Corresponds to the JSON property logConfig
7140 7141 7142 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7140 def log_config @log_config end |
#name ⇒ String
Name of the resource; provided by the client when the resource is created. The
name must be 1-63 characters long, and comply with RFC1035. Specifically, the
name must be 1-63 characters long and match the regular expression [a-z]([-a-
z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all
following characters (except for the last character) must be a dash, lowercase
letter, or digit. The last character must be a lowercase letter or digit.
Corresponds to the JSON property
name`
7150 7151 7152 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7150 def name @name end |
#network ⇒ String
URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
- https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my- network
- projects/myproject/global/networks/my-network
- global/networks/default
Corresponds to the JSON property
network
7163 7164 7165 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7163 def network @network end |
#priority ⇒ Fixnum
Priority for this rule. This is an integer between 0
and 65535
, both
inclusive. The default value is 1000
. Relative priorities determine which
rule takes effect if multiple rules apply. Lower values indicate higher
priority. For example, a rule with priority 0
has higher precedence than a
rule with priority 1
. DENY rules take precedence over ALLOW rules if they
have equal priority. Note that VPC networks have implied rules with a priority
of 65535
. To avoid conflicts with the implied rules, use a priority number
less than 65535
.
Corresponds to the JSON property priority
7175 7176 7177 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7175 def priority @priority end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
7180 7181 7182 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7180 def self_link @self_link end |
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
Corresponds to the JSON property selfLinkWithId
7185 7186 7187 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7185 def self_link_with_id @self_link_with_id end |
#source_ranges ⇒ Array<String>
If source ranges are specified, the firewall rule applies only to traffic that
has a source IP address in these ranges. These ranges must be expressed in
CIDR format. One or both of sourceRanges and sourceTags may be set. If both
fields are set, the rule applies to traffic that has a source IP address
within sourceRanges OR a source IP from a resource with a matching tag listed
in the sourceTags field. The connection does not need to match both fields for
the rule to apply. Only IPv4 is supported.
Corresponds to the JSON property sourceRanges
7196 7197 7198 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7196 def source_ranges @source_ranges end |
#source_service_accounts ⇒ Array<String>
If source service accounts are specified, the firewall rules apply only to
traffic originating from an instance with a service account in this list.
Source service accounts cannot be used to control traffic to an instance's
external IP address because service accounts are associated with an instance,
not an IP address. sourceRanges can be set at the same time as
sourceServiceAccounts. If both are set, the firewall applies to traffic that
has a source IP address within the sourceRanges OR a source IP that belongs to
an instance with service account listed in sourceServiceAccount. The
connection does not need to match both fields for the firewall to apply.
sourceServiceAccounts cannot be used at the same time as sourceTags or
targetTags.
Corresponds to the JSON property sourceServiceAccounts
7211 7212 7213 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7211 def source_service_accounts @source_service_accounts end |
#source_tags ⇒ Array<String>
If source tags are specified, the firewall rule applies only to traffic with
source IPs that match the primary network interfaces of VM instances that have
the tag and are in the same VPC network. Source tags cannot be used to control
traffic to an instance's external IP address, it only applies to traffic
between instances in the same virtual network. Because tags are associated
with instances, not IP addresses. One or both of sourceRanges and sourceTags
may be set. If both fields are set, the firewall applies to traffic that has a
source IP address within sourceRanges OR a source IP from a resource with a
matching tag listed in the sourceTags field. The connection does not need to
match both fields for the firewall to apply.
Corresponds to the JSON property sourceTags
7225 7226 7227 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7225 def @source_tags end |
#target_service_accounts ⇒ Array<String>
A list of service accounts indicating sets of instances located in the network
that may make network connections as specified in allowed[].
targetServiceAccounts cannot be used at the same time as targetTags or
sourceTags. If neither targetServiceAccounts nor targetTags are specified, the
firewall rule applies to all instances on the specified network.
Corresponds to the JSON property targetServiceAccounts
7234 7235 7236 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7234 def target_service_accounts @target_service_accounts end |
#target_tags ⇒ Array<String>
A list of tags that controls which instances the firewall rule applies to. If
targetTags are specified, then the firewall rule applies only to instances in
the VPC network that have one of those tags. If no targetTags are specified,
the firewall rule applies to all instances on the specified network.
Corresponds to the JSON property targetTags
7242 7243 7244 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7242 def @target_tags end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 7249 def update!(**args) @allowed = args[:allowed] if args.key?(:allowed) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @denied = args[:denied] if args.key?(:denied) @description = args[:description] if args.key?(:description) @destination_ranges = args[:destination_ranges] if args.key?(:destination_ranges) @direction = args[:direction] if args.key?(:direction) @disabled = args[:disabled] if args.key?(:disabled) @enable_logging = args[:enable_logging] if args.key?(:enable_logging) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @log_config = args[:log_config] if args.key?(:log_config) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) @priority = args[:priority] if args.key?(:priority) @self_link = args[:self_link] if args.key?(:self_link) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @source_ranges = args[:source_ranges] if args.key?(:source_ranges) @source_service_accounts = args[:source_service_accounts] if args.key?(:source_service_accounts) @source_tags = args[:source_tags] if args.key?(:source_tags) @target_service_accounts = args[:target_service_accounts] if args.key?(:target_service_accounts) @target_tags = args[:target_tags] if args.key?(:target_tags) end |