Definitions for @turbot/gcp-network

{
  "type": "object",
  "properties": {
    "name": {
      "$ref": "#/definitions/resourceName"
    },
    "creationTimestamp": {
      "$ref": "turbot#/definitions/isoTimestamp"
    },
    "status": {
      "$ref": "#/definitions/addressStatus"
    },
    "labels": {
      "$ref": "gcp#/definitions/labels"
    },
    "labelFingerprint": {
      "$ref": "gcp#/definitions/fingerprint"
    },
    "address": {
      "$ref": "#/definitions/ipAddress"
    },
    "turbot": {
      "type": "object",
      "properties": {
        "akas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/addressAka"
          }
        },
        "tags": {
          "$ref": "gcp#/definitions/labels"
        },
        "title": {
          "$ref": "#/definitions/resourceName"
        },
        "custom": {
          "type": "object",
          "properties": {
            "gcp": {
              "$ref": "gcp#/definitions/gcpMetadata"
            },
            "createTimestamp": {
              "$ref": "turbot#/definitions/isoTimestamp"
            }
          }
        }
      }
    }
  },
  "required": [
    "name",
    "turbot"
  ],
  "additionalProperties": true,
  "tests": [
    {
      "description": "Valid - All properties",
      "input": {
        "name": "testelb",
        "address": "192.32.31.2",
        "status": "IN_USE",
        "turbot": {
          "custom": {
            "gcp": {
              "projectId": "123-456",
              "regionName": "us-west1"
            },
            "createTimeStamp": "2000-01-01T00:00:00.000Z"
          }
        }
      }
    },
    {
      "description": "Invalid - Missing name",
      "input": {
        "address": "192.32.31.2",
        "status": "IN_USE",
        "turbot": {
          "custom": {
            "gcp": {
              "projectId": "123-456",
              "regionName": "us-west1"
            },
            "createTimeStamp": "2000-01-01T00:00:00.000Z"
          }
        }
      },
      "expected": false
    },
    {
      "description": "Invalid - Missing Guardrails data",
      "input": {
        "name": "tes01",
        "address": "192.32.31.2",
        "status": "IN_USE"
      },
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/address",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "description": "Represents an IP Address resource. Google Compute Engine has two IP Address resources: * [Global (external and internal)](https://cloud.google.com/compute/docs/reference/rest/v1/globalAddresses) * [Regional (external and internal)](https://cloud.google.com/compute/docs/reference/rest/v1/addresses) For more information, see Reserving a static external IP address.",
  "properties": {
    "address": {
      "description": "The static IP address represented by this resource.",
      "type": "string"
    },
    "addressType": {
      "description": "The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.",
      "enum": [
        "EXTERNAL",
        "INTERNAL",
        "UNSPECIFIED_TYPE"
      ],
      "type": "string"
    },
    "creationTimestamp": {
      "description": "[Output Only] Creation timestamp in RFC3339 text format.",
      "type": "string"
    },
    "description": {
      "description": "An optional description of this resource. Provide this field when you create the resource.",
      "type": "string"
    },
    "id": {
      "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
      "type": "string"
    },
    "ipVersion": {
      "description": "The IP version that will be used by this address. Valid options are IPV4 or IPV6.",
      "enum": [
        "IPV4",
        "IPV6",
        "UNSPECIFIED_VERSION"
      ],
      "type": "string"
    },
    "ipv6EndpointType": {
      "description": "The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.",
      "enum": [
        "NETLB",
        "VM"
      ],
      "type": "string"
    },
    "kind": {
      "default": "compute#address",
      "description": "[Output Only] Type of the resource. Always compute#address for addresses.",
      "type": "string"
    },
    "labelFingerprint": {
      "description": "A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.",
      "type": "string"
    },
    "labels": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.",
      "type": "object"
    },
    "name": {
      "description": "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.",
      "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
      "type": "string"
    },
    "network": {
      "description": "The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.",
      "type": "string"
    },
    "networkTier": {
      "description": "This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.",
      "enum": [
        "FIXED_STANDARD",
        "PREMIUM",
        "STANDARD",
        "STANDARD_OVERRIDES_FIXED_STANDARD"
      ],
      "type": "string"
    },
    "prefixLength": {
      "description": "The prefix length if the resource represents an IP range.",
      "type": "integer"
    },
    "purpose": {
      "description": "The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. ",
      "enum": [
        "DNS_RESOLVER",
        "GCE_ENDPOINT",
        "IPSEC_INTERCONNECT",
        "NAT_AUTO",
        "PRIVATE_SERVICE_CONNECT",
        "SERVERLESS",
        "SHARED_LOADBALANCER_VIP",
        "VPC_PEERING"
      ],
      "type": "string"
    },
    "region": {
      "description": "[Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.*",
      "type": "string"
    },
    "selfLink": {
      "description": "[Output Only] Server-defined URL for the resource.",
      "type": "string"
    },
    "status": {
      "description": "[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.",
      "enum": [
        "IN_USE",
        "RESERVED",
        "RESERVING"
      ],
      "type": "string"
    },
    "subnetwork": {
      "description": "The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.",
      "type": "string"
    },
    "users": {
      "description": "[Output Only] The URLs of the resources that are using this address.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object",
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/Address",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "type": "string",
  "pattern": "^gcp://compute.googleapis.com/projects/[a-z0-9-]{5,29}[a-z0-9]{1}/regions/(asia-east1|asia-east2|asia-northeast1|asia-south1|asia-southeast1|australia-southeast1|europe-north1|europe-west1|europe-west2|europe-west3|europe-west4|northamerica-northeast1|southamerica-east1|us-central1|us-east1|us-east4|us-west1|us-west2|global)/addresses/[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?$",
  "tests": [
    {
      "descritpion": "base case",
      "input": "gcp://compute.googleapis.com/projects/aar-a4b6d489/regions/us-west1/addresses/test01"
    },
    {
      "description": "invalid - invalid region name",
      "input": "gcp://compute.googleapis.com/projects/aar-a4b6d489/regions/asiaus/addresses/test01",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/addressAka",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "type": "string",
  "enum": [
    "RESERVING",
    "RESERVED",
    "IN_USE"
  ],
  "tests": [
    {
      "input": "IN_USE"
    },
    {
      "input": "RESERVED"
    },
    {
      "description": "invalid - not listed in options",
      "input": "RUNNABLE",
      "expected": false
    },
    {
      "description": "invalid - null value",
      "input": null,
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/addressStatus",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.",
  "properties": {
    "auditLogConfigs": {
      "description": "The configuration for logging of each type of permission.",
      "items": {
        "$ref": "#/definitions/AuditLogConfig"
      },
      "type": "array"
    },
    "exemptedMembers": {
      "description": "This is deprecated and has no effect. Do not use.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "service": {
      "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
      "type": "string"
    }
  },
  "type": "object",
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/AuditConfig",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.",
  "properties": {
    "exemptedMembers": {
      "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "ignoreChildExemptions": {
      "description": "This is deprecated and has no effect. Do not use.",
      "type": "boolean"
    },
    "logType": {
      "description": "The log type that this config enables.",
      "enum": [
        "ADMIN_READ",
        "DATA_READ",
        "DATA_WRITE",
        "LOG_TYPE_UNSPECIFIED"
      ],
      "type": "string"
    }
  },
  "type": "object",
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/AuditLogConfig",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "description": "This is deprecated and has no effect. Do not use.",
  "properties": {
    "permissionType": {
      "description": "This is deprecated and has no effect. Do not use.",
      "enum": [
        "ADMIN_READ",
        "ADMIN_WRITE",
        "DATA_READ",
        "DATA_WRITE",
        "PERMISSION_TYPE_UNSPECIFIED"
      ],
      "type": "string"
    }
  },
  "type": "object",
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/AuthorizationLoggingOptions",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "description": "Contains the configurations necessary to generate a signature for access to private storage buckets that support Signature Version 4 for authentication. The service name for generating the authentication header will always default to 's3'.",
  "properties": {
    "accessKey": {
      "description": "The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly",
      "type": "string"
    },
    "accessKeyId": {
      "description": "The identifier of an access key used for s3 bucket authentication.",
      "type": "string"
    },
    "accessKeyVersion": {
      "description": "The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.",
      "type": "string"
    },
    "originRegion": {
      "description": "The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, \"us-east-1\" for AWS or \"us-ashburn-1\" for OCI.",
      "type": "string"
    }
  },
  "type": "object",
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/AWSV4Signature",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "description": "Message containing information of one individual backend.",
  "properties": {
    "balancingMode": {
      "description": "Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.",
      "enum": [
        "CONNECTION",
        "RATE",
        "UTILIZATION"
      ],
      "type": "string"
    },
    "capacityScaler": {
      "description": "A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.",
      "type": "number"
    },
    "description": {
      "description": "An optional description of this resource. Provide this property when you create the resource.",
      "type": "string"
    },
    "failover": {
      "description": "This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.",
      "type": "boolean"
    },
    "group": {
      "description": "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.",
      "type": "string"
    },
    "maxConnections": {
      "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.",
      "type": "integer"
    },
    "maxConnectionsPerEndpoint": {
      "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.",
      "type": "integer"
    },
    "maxConnectionsPerInstance": {
      "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.",
      "type": "integer"
    },
    "maxRate": {
      "description": "Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.",
      "type": "integer"
    },
    "maxRatePerEndpoint": {
      "description": "Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.",
      "type": "number"
    },
    "maxRatePerInstance": {
      "description": "Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.",
      "type": "number"
    },
    "maxUtilization": {
      "description": "Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.",
      "type": "number"
    }
  },
  "type": "object",
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/Backend",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "$ref": "#/definitions/resourceName"
    },
    "turbot": {
      "type": "object",
      "properties": {
        "akas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/backendBucketAka"
          }
        },
        "title": {
          "$ref": "#/definitions/resourceName"
        },
        "custom": {
          "type": "object",
          "properties": {
            "gcp": {
              "$ref": "gcp#/definitions/gcpMetadata"
            },
            "createTimestamp": {
              "$ref": "turbot#/definitions/isoTimestamp"
            },
            "hasData": {
              "type": "boolean"
            }
          }
        }
      }
    }
  },
  "required": [
    "name",
    "turbot"
  ],
  "additionalProperties": true,
  "tests": [
    {
      "description": "Valid - All properties",
      "input": {
        "name": "tes01",
        "turbot": {
          "custom": {
            "gcp": {
              "projectId": "123-456"
            }
          }
        }
      }
    },
    {
      "description": "Invalid - Missing  name",
      "input": {
        "turbot": {
          "custom": {
            "gcp": {
              "projectId": "123-456"
            }
          }
        }
      },
      "expected": false
    },
    {
      "description": "Invalid - Missing Guardrails data",
      "input": {
        "name": "test01"
      },
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/backendBucket",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "description": "Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.",
  "properties": {
    "bucketName": {
      "description": "Cloud Storage bucket name.",
      "type": "string"
    },
    "cdnPolicy": {
      "$ref": "#/definitions/BackendBucketCdnPolicy",
      "description": "Cloud CDN configuration for this BackendBucket."
    },
    "compressionMode": {
      "description": "Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.",
      "enum": [
        "AUTOMATIC",
        "DISABLED"
      ],
      "type": "string"
    },
    "creationTimestamp": {
      "description": "[Output Only] Creation timestamp in RFC3339 text format.",
      "type": "string"
    },
    "customResponseHeaders": {
      "description": "Headers that the Application Load Balancer should add to proxied responses.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "description": {
      "description": "An optional textual description of the resource; provided by the client when the resource is created.",
      "type": "string"
    },
    "edgeSecurityPolicy": {
      "description": "[Output Only] The resource URL for the edge security policy associated with this backend bucket.",
      "type": "string"
    },
    "enableCdn": {
      "description": "If true, enable Cloud CDN for this BackendBucket.",
      "type": "boolean"
    },
    "id": {
      "description": "[Output Only] Unique identifier for the resource; defined by the server.",
      "type": "string"
    },
    "kind": {
      "default": "compute#backendBucket",
      "description": "Type of the resource.",
      "type": "string"
    },
    "name": {
      "description": "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])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
      "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
      "type": "string"
    },
    "selfLink": {
      "description": "[Output Only] Server-defined URL for the resource.",
      "type": "string"
    }
  },
  "type": "object",
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/BackendBucket",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "type": "string",
  "pattern": "^gcp://compute.googleapis.com/projects/[a-z0-9-]{5,29}[a-z0-9]{1}/global/backendBuckets/[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?$",
  "tests": [
    {
      "descritpion": "base case",
      "input": "gcp://compute.googleapis.com/projects/aar-a4b6d489/global/backendBuckets/test01"
    },
    {
      "description": "invalid - invalid  name",
      "input": "gcp://compute.googleapis.com/projects/aar-a4b6d489/global/backendBuckets/test01-",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/backendBucketAka",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "description": "Message containing Cloud CDN configuration for a backend bucket.",
  "properties": {
    "bypassCacheOnRequestHeaders": {
      "description": "Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.",
      "items": {
        "$ref": "#/definitions/BackendBucketCdnPolicyBypassCacheOnRequestHeader"
      },
      "type": "array"
    },
    "cacheKeyPolicy": {
      "$ref": "#/definitions/BackendBucketCdnPolicyCacheKeyPolicy",
      "description": "The CacheKeyPolicy for this CdnPolicy."
    },
    "cacheMode": {
      "description": "Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.",
      "enum": [
        "CACHE_ALL_STATIC",
        "FORCE_CACHE_ALL",
        "INVALID_CACHE_MODE",
        "USE_ORIGIN_HEADERS"
      ],
      "type": "string"
    },
    "clientTtl": {
      "description": "Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a \"public\" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a \"public\" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).",
      "type": "integer"
    },
    "defaultTtl": {
      "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.",
      "type": "integer"
    },
    "maxTtl": {
      "description": "Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of \"0\" means \"always revalidate\". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.",
      "type": "integer"
    },
    "negativeCaching": {
      "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.",
      "type": "boolean"
    },
    "negativeCachingPolicy": {
      "description": "Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.",
      "items": {
        "$ref": "#/definitions/BackendBucketCdnPolicyNegativeCachingPolicy"
      },
      "type": "array"
    },
    "requestCoalescing": {
      "description": "If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.",
      "type": "boolean"
    },
    "serveWhileStale": {
      "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.",
      "type": "integer"
    },
    "signedUrlCacheMaxAgeSec": {
      "description": "Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a \"Cache-Control: public, max-age=[TTL]\" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.",
      "type": "string"
    },
    "signedUrlKeyNames": {
      "description": "[Output Only] Names of the keys for signing request URLs.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object",
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/BackendBucketCdnPolicy",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "description": "Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.",
  "properties": {
    "headerName": {
      "description": "The header field name to match on when bypassing cache. Values are case-insensitive.",
      "type": "string"
    }
  },
  "type": "object",
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/BackendBucketCdnPolicyBypassCacheOnRequestHeader",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "description": "Message containing what to include in the cache key for a request for Cloud CDN.",
  "properties": {
    "includeHttpHeaders": {
      "description": "Allows HTTP request headers (by name) to be used in the cache key.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "queryStringWhitelist": {
      "description": "Names of query string parameters to include in cache keys. Default parameters are always included. '&' and '=' will be percent encoded and not treated as delimiters.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object",
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/BackendBucketCdnPolicyCacheKeyPolicy",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "description": "Specify CDN TTLs for response error codes.",
  "properties": {
    "code": {
      "description": "The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.",
      "type": "integer"
    },
    "ttl": {
      "description": "The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.",
      "type": "integer"
    }
  },
  "type": "object",
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/BackendBucketCdnPolicyNegativeCachingPolicy",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "$ref": "#/definitions/resourceName"
    },
    "turbot": {
      "type": "object",
      "properties": {
        "akas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/backendServiceAka"
          }
        },
        "title": {
          "$ref": "#/definitions/resourceName"
        },
        "custom": {
          "type": "object",
          "properties": {
            "gcp": {
              "$ref": "gcp#/definitions/gcpMetadata"
            },
            "createTimestamp": {
              "$ref": "turbot#/definitions/isoTimestamp"
            }
          }
        }
      }
    }
  },
  "additionalProperties": true,
  "tests": [
    {
      "description": "Valid - All properties",
      "input": {
        "name": "tes01",
        "turbot": {
          "custom": {
            "gcp": {
              "projectId": "123-456"
            }
          }
        }
      }
    },
    {
      "description": "Invalid - Missing  name",
      "input": {
        "turbot": {
          "custom": {
            "gcp": {
              "projectId": "123-456",
              "regionName": "southamerica-east1"
            }
          }
        }
      },
      "expected": false
    },
    {
      "description": "Invalid - Missing Guardrails data",
      "input": {
        "name": "tes01"
      },
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/backendService",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "description": "Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices) For more information, see Backend Services.",
  "properties": {
    "affinityCookieTtlSec": {
      "description": "Lifetime of cookies in seconds. This setting is applicable to Application Load Balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
      "type": "integer"
    },
    "backends": {
      "description": "The list of backends that serve this BackendService.",
      "items": {
        "$ref": "#/definitions/Backend"
      },
      "type": "array"
    },
    "cdnPolicy": {
      "$ref": "#/definitions/BackendServiceCdnPolicy",
      "description": "Cloud CDN configuration for this BackendService. Only available for specified load balancer types."
    },
    "circuitBreakers": {
      "$ref": "#/definitions/CircuitBreakers"
    },
    "compressionMode": {
      "description": "Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.",
      "enum": [
        "AUTOMATIC",
        "DISABLED"
      ],
      "type": "string"
    },
    "connectionDraining": {
      "$ref": "#/definitions/ConnectionDraining"
    },
    "connectionTrackingPolicy": {
      "$ref": "#/definitions/BackendServiceConnectionTrackingPolicy",
      "description": "Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers."
    },
    "consistentHash": {
      "$ref": "#/definitions/ConsistentHashLoadBalancerSettings",
      "description": "Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. "
    },
    "creationTimestamp": {
      "description": "[Output Only] Creation timestamp in RFC3339 text format.",
      "type": "string"
    },
    "customRequestHeaders": {
      "description": "Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "customResponseHeaders": {
      "description": "Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "description": {
      "description": "An optional description of this resource. Provide this property when you create the resource.",
      "type": "string"
    },
    "edgeSecurityPolicy": {
      "description": "[Output Only] The resource URL for the edge security policy associated with this backend service.",
      "type": "string"
    },
    "enableCDN": {
      "description": "If true, enables Cloud CDN for the backend service of a global external Application Load Balancer.",
      "type": "boolean"
    },
    "failoverPolicy": {
      "$ref": "#/definitions/BackendServiceFailoverPolicy",
      "description": "Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview)."
    },
    "fingerprint": {
      "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.",
      "type": "string"
    },
    "healthChecks": {
      "description": "The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "iap": {
      "$ref": "#/definitions/BackendServiceIAP",
      "description": "The configurations for Identity-Aware Proxy on this resource. Not available for internal passthrough Network Load Balancers and external passthrough Network Load Balancers."
    },
    "id": {
      "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
      "type": "string"
    },
    "kind": {
      "default": "compute#backendService",
      "description": "[Output Only] Type of resource. Always compute#backendService for backend services.",
      "type": "string"
    },
    "loadBalancingScheme": {
      "description": "Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.",
      "enum": [
        "EXTERNAL",
        "EXTERNAL_MANAGED",
        "INTERNAL",
        "INTERNAL_MANAGED",
        "INTERNAL_SELF_MANAGED",
        "INVALID_LOAD_BALANCING_SCHEME"
      ],
      "type": "string"
    },
    "localityLbPolicies": {
      "description": "A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.",
      "items": {
        "$ref": "#/definitions/BackendServiceLocalityLoadBalancingPolicyConfig"
      },
      "type": "array"
    },
    "localityLbPolicy": {
      "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
      "enum": [
        "INVALID_LB_POLICY",
        "LEAST_REQUEST",
        "MAGLEV",
        "ORIGINAL_DESTINATION",
        "RANDOM",
        "RING_HASH",
        "ROUND_ROBIN",
        "WEIGHTED_MAGLEV"
      ],
      "type": "string"
    },
    "logConfig": {
      "$ref": "#/definitions/BackendServiceLogConfig",
      "description": "This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver."
    },
    "maxStreamDuration": {
      "$ref": "#/definitions/Duration",
      "description": "Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED."
    },
    "metadatas": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH",
      "type": "object"
    },
    "name": {
      "description": "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])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
      "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
      "type": "string"
    },
    "network": {
      "description": "The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.",
      "type": "string"
    },
    "outlierDetection": {
      "$ref": "#/definitions/OutlierDetection",
      "description": "Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true."
    },
    "port": {
      "deprecated": true,
      "description": "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port.",
      "type": "integer"
    },
    "portName": {
      "description": "A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port_name.",
      "type": "string"
    },
    "protocol": {
      "description": "The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.",
      "enum": [
        "GRPC",
        "HTTP",
        "HTTP2",
        "HTTPS",
        "SSL",
        "TCP",
        "UDP",
        "UNSPECIFIED"
      ],
      "type": "string"
    },
    "region": {
      "description": "[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
      "type": "string"
    },
    "securityPolicy": {
      "description": "[Output Only] The resource URL for the security policy associated with this backend service.",
      "type": "string"
    },
    "securitySettings": {
      "$ref": "#/definitions/SecuritySettings",
      "description": "This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED."
    },
    "selfLink": {
      "description": "[Output Only] Server-defined URL for the resource.",
      "type": "string"
    },
    "serviceBindings": {
      "description": "URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "sessionAffinity": {
      "description": "Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).",
      "enum": [
        "CLIENT_IP",
        "CLIENT_IP_NO_DESTINATION",
        "CLIENT_IP_PORT_PROTO",
        "CLIENT_IP_PROTO",
        "GENERATED_COOKIE",
        "HEADER_FIELD",
        "HTTP_COOKIE",
        "NONE"
      ],
      "type": "string"
    },
    "subsetting": {
      "$ref": "#/definitions/Subsetting"
    },
    "timeoutSec": {
      "description": "The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.",
      "type": "integer"
    },
    "usedBy": {
      "items": {
        "$ref": "#/definitions/BackendServiceUsedBy"
      },
      "type": "array"
    }
  },
  "type": "object",
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/BackendService",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "type": "string",
  "pattern": "^gcp://compute.googleapis.com/projects/[a-z0-9-]{5,29}[a-z0-9]{1}/global/backendServices/[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?$",
  "tests": [
    {
      "descritpion": "base case",
      "input": "gcp://compute.googleapis.com/projects/aar-a4b6d489/global/backendServices/test01"
    },
    {
      "description": "invalid - invalid  name",
      "input": "gcp://compute.googleapis.com/projects/aar-a4b6d489/global/backendServices/test01-",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/backendServiceAka",
    "modUri": "tmod:@turbot/gcp-network"
  }
}

{
  "description": "Message containing Cloud CDN configuration for a backend service.",
  "properties": {
    "bypassCacheOnRequestHeaders": {
      "description": "Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.",
      "items": {
        "$ref": "#/definitions/BackendServiceCdnPolicyBypassCacheOnRequestHeader"
      },
      "type": "array"
    },
    "cacheKeyPolicy": {
      "$ref": "#/definitions/CacheKeyPolicy",
      "description": "The CacheKeyPolicy for this CdnPolicy."
    },
    "cacheMode": {
      "description": "Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.",
      "enum": [
        "CACHE_ALL_STATIC",
        "FORCE_CACHE_ALL",
        "INVALID_CACHE_MODE",
        "USE_ORIGIN_HEADERS"
      ],
      "type": "string"
    },
    "clientTtl": {
      "description": "Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a \"public\" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a \"public\" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).",
      "type": "integer"
    },
    "defaultTtl": {
      "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.",
      "type": "integer"
    },
    "maxTtl": {
      "description": "Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of \"0\" means \"always revalidate\". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.",
      "type": "integer"
    },
    "negativeCaching": {
      "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.",
      "type": "boolean"
    },
    "negativeCachingPolicy": {
      "description": "Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.",
      "items": {
        "$ref": "#/definitions/BackendServiceCdnPolicyNegativeCachingPolicy"
      },
      "type": "array"
    },
    "requestCoalescing": {
      "description": "If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.",
      "type": "boolean"
    },
    "serveWhileStale": {
      "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.",
      "type": "integer"
    },
    "signedUrlCacheMaxAgeSec": {
      "description": "Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a \"Cache-Control: public, max-age=[TTL]\" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.",
      "type": "string"
    },
    "signedUrlKeyNames": {
      "description": "[Output Only] Names of the keys for signing request URLs.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object",
  ".turbot": {
    "uri": "tmod:@turbot/gcp-network#/definitions/BackendServiceCdnPolicy",
    "modUri": "tmod:@turbot/gcp-network"
  }
}