Class FirewallPolicyRule (1.23.0)

FirewallPolicyRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
action str
The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". This field is a member of oneof_ _action.
description str
An optional description for this resource. This field is a member of oneof_ _description.
direction str
The direction in which this rule applies. Check the Direction enum for the list of possible values. This field is a member of oneof_ _direction.
disabled bool
Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. This field is a member of oneof_ _disabled.
enable_logging bool
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 is a member of oneof_ _enable_logging.
kind str
[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. This field is a member of oneof_ _kind.
match google.cloud.compute_v1.types.FirewallPolicyRuleMatcher
A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. This field is a member of oneof_ _match.
priority int
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. This field is a member of oneof_ _priority.
rule_name str
An optional name for the rule. This field is not a unique identifier and can be updated. This field is a member of oneof_ _rule_name.
rule_tuple_count int
[Output Only] Calculation of the complexity of a single firewall policy rule. This field is a member of oneof_ _rule_tuple_count.
security_profile_group str
A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. This field is a member of oneof_ _security_profile_group.
target_resources MutableSequence[str]
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.
target_secure_tags MutableSequence[google.cloud.compute_v1.types.FirewallPolicyRuleSecureTag]
A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
target_service_accounts MutableSequence[str]
A list of service accounts indicating the sets of instances that are applied with this rule.
tls_inspect bool
Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. This field is a member of oneof_ _tls_inspect.

Classes

Direction

Direction(value)

The direction in which this rule applies.