computefirewallpolicyrule_v1beta1.json

{
  "description": "ComputeFirewallPolicyRule is the Schema for the compute API",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "properties": {
        "action": {
          "description": "The Action to perform when the client connection triggers the rule. Valid actions are \"allow\", \"deny\" and \"goto_next\".",
          "type": "string"
        },
        "description": {
          "description": "An optional description for this resource.",
          "type": "string"
        },
        "direction": {
          "description": "The direction in which this rule applies. Possible values: INGRESS, EGRESS",
          "type": "string"
        },
        "disabled": {
          "description": "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.",
          "type": "boolean"
        },
        "enableLogging": {
          "description": "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.",
          "type": "boolean"
        },
        "firewallPolicyRef": {
          "description": "Immutable.",
          "oneOf": [
            {
              "not": {
                "required": [
                  "external"
                ]
              },
              "required": [
                "name"
              ]
            },
            {
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "name"
                    ]
                  },
                  {
                    "required": [
                      "namespace"
                    ]
                  }
                ]
              },
              "required": [
                "external"
              ]
            }
          ],
          "properties": {
            "external": {
              "description": "A reference to an externally managed ComputeFirewallPolicy resource. Should be in the format `locations/global/firewallPolicies/<firewallPolicy>`.",
              "type": "string"
            },
            "name": {
              "description": "The `name` field of a `ComputeFirewall olicy ` resource.",
              "type": "string"
            },
            "namespace": {
              "description": "The `namespace` field of a `ComputeFirewallPolicy ` resource.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "match": {
          "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.",
          "properties": {
            "destAddressGroups": {
              "description": "Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "destFqdns": {
              "description": "Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "destIPRanges": {
              "description": "CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "destRegionCodes": {
              "description": "The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "destThreatIntelligences": {
              "description": "Name of the Google Cloud Threat Intelligence list.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "layer4Configs": {
              "description": "Pairs of IP protocols and ports that the rule should match.",
              "items": {
                "properties": {
                  "ipProtocol": {
                    "description": "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (`tcp`, `udp`, `icmp`, `esp`, `ah`, `ipip`, `sctp`), or the IP protocol number.",
                    "type": "string"
                  },
                  "ports": {
                    "description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ``.",
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "required": [
                  "ipProtocol"
                ],
                "type": "object",
                "additionalProperties": false
              },
              "type": "array"
            },
            "srcAddressGroups": {
              "description": "Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "srcFqdns": {
              "description": "Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "srcIPRanges": {
              "description": "CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "srcRegionCodes": {
              "description": "The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "srcThreatIntelligences": {
              "description": "Name of the Google Cloud Threat Intelligence list.",
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "layer4Configs"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "priority": {
          "description": "Immutable. 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 prority.",
          "format": "int64",
          "type": "integer"
        },
        "targetResources": {
          "items": {
            "oneOf": [
              {
                "not": {
                  "required": [
                    "external"
                  ]
                },
                "required": [
                  "name"
                ]
              },
              {
                "not": {
                  "anyOf": [
                    {
                      "required": [
                        "name"
                      ]
                    },
                    {
                      "required": [
                        "namespace"
                      ]
                    }
                  ]
                },
                "required": [
                  "external"
                ]
              }
            ],
            "properties": {
              "external": {
                "description": "A reference to an externally managed Compute Network resource. Should be in the format `projects/<projectID>/global/networks/<network>`.",
                "type": "string"
              },
              "name": {
                "description": "The `name` field of a `ComputeNetwork` resource.",
                "type": "string"
              },
              "namespace": {
                "description": "The `namespace` field of a `ComputeNetwork` resource.",
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "targetServiceAccounts": {
          "items": {
            "oneOf": [
              {
                "not": {
                  "required": [
                    "external"
                  ]
                },
                "required": [
                  "name"
                ]
              },
              {
                "not": {
                  "anyOf": [
                    {
                      "required": [
                        "name"
                      ]
                    },
                    {
                      "required": [
                        "namespace"
                      ]
                    }
                  ]
                },
                "required": [
                  "external"
                ]
              }
            ],
            "properties": {
              "external": {
                "description": "The `email` field of an `IAMServiceAccount` resource.",
                "type": "string"
              },
              "name": {
                "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                "type": "string"
              },
              "namespace": {
                "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        }
      },
      "required": [
        "action",
        "direction",
        "firewallPolicyRef",
        "match",
        "priority"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "properties": {
        "conditions": {
          "description": "Conditions represent the latest available observations of the object's current state.",
          "items": {
            "properties": {
              "lastTransitionTime": {
                "description": "Last time the condition transitioned from one status to another.",
                "type": "string"
              },
              "message": {
                "description": "Human-readable message indicating details about last transition.",
                "type": "string"
              },
              "reason": {
                "description": "Unique, one-word, CamelCase reason for the condition's last transition.",
                "type": "string"
              },
              "status": {
                "description": "Status is the status of the condition. Can be True, False, Unknown.",
                "type": "string"
              },
              "type": {
                "description": "Type is the type of the condition.",
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "externalRef": {
          "description": "A unique Config Connector specifier for the resource in GCP.",
          "type": "string"
        },
        "kind": {
          "description": "Type of the resource. Always `compute#firewallPolicyRule` for firewall policy rules",
          "type": "string"
        },
        "observedGeneration": {
          "description": "ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.",
          "format": "int64",
          "type": "integer"
        },
        "ruleTupleCount": {
          "description": "Calculation of the complexity of a single firewall policy rule.",
          "format": "int64",
          "type": "integer"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}