ComputeBackendBucket

Stay organized with collections Save and categorize content based on your preferences.
Property Value
Google Cloud Service Name Compute Engine
Google Cloud Service Documentation /compute/docs/
Google Cloud REST Resource Name v1.backendBucket
Google Cloud REST Resource Documentation /compute/docs/reference/rest/v1/backendBuckets
Config Connector Resource Short Names gcpcomputebackendbucket
gcpcomputebackendbuckets
computebackendbucket
Config Connector Service Name compute.googleapis.com
Config Connector Resource Fully Qualified Name computebackendbuckets.compute.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember Yes
Supports IAM Conditions No
Supports IAM Audit Configs No
IAM External Reference Format

projects/{{project}}/global/backendBuckets/{{name}}

Custom Resource Definition Properties

Annotations

Fields
cnrm.cloud.google.com/project-id
cnrm.cloud.google.com/state-into-spec

Spec

Schema

bucketRef:
  external: string
  name: string
  namespace: string
cdnPolicy:
  bypassCacheOnRequestHeaders:
  - headerName: string
  cacheKeyPolicy:
    includeHttpHeaders:
    - string
    queryStringWhitelist:
    - string
  cacheMode: string
  clientTtl: integer
  defaultTtl: integer
  maxTtl: integer
  negativeCaching: boolean
  negativeCachingPolicy:
  - code: integer
    ttl: integer
  requestCoalescing: boolean
  serveWhileStale: integer
  signedUrlCacheMaxAgeSec: integer
customResponseHeaders:
- string
description: string
edgeSecurityPolicy: string
enableCdn: boolean
resourceID: string
Fields

bucketRef

Required

object

Reference to the bucket.

bucketRef.external

Optional

string

Allowed value: The `name` field of a `StorageBucket` resource.

bucketRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

bucketRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

cdnPolicy

Optional

object

Cloud CDN configuration for this Backend Bucket.

cdnPolicy.bypassCacheOnRequestHeaders

Optional

list (object)

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.

cdnPolicy.bypassCacheOnRequestHeaders[]

Optional

object

cdnPolicy.bypassCacheOnRequestHeaders[].headerName

Optional

string

The header field name to match on when bypassing cache. Values are case-insensitive.

cdnPolicy.cacheKeyPolicy

Optional

object

The CacheKeyPolicy for this CdnPolicy.

cdnPolicy.cacheKeyPolicy.includeHttpHeaders

Optional

list (string)

Allows HTTP request headers (by name) to be used in the cache key.

cdnPolicy.cacheKeyPolicy.includeHttpHeaders[]

Optional

string

cdnPolicy.cacheKeyPolicy.queryStringWhitelist

Optional

list (string)

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.

cdnPolicy.cacheKeyPolicy.queryStringWhitelist[]

Optional

string

cdnPolicy.cacheMode

Optional

string

Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL and CACHE_ALL_STATIC Possible values: ["USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"].

cdnPolicy.clientTtl

Optional

integer

Specifies the maximum allowed TTL for cached content served by this origin.

cdnPolicy.defaultTtl

Optional

integer

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

cdnPolicy.maxTtl

Optional

integer

Specifies the maximum allowed TTL for cached content served by this origin.

cdnPolicy.negativeCaching

Optional

boolean

Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.

cdnPolicy.negativeCachingPolicy

Optional

list (object)

Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy. Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs.

cdnPolicy.negativeCachingPolicy[]

Optional

object

cdnPolicy.negativeCachingPolicy[].code

Optional

integer

The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 308, 404, 405, 410, 421, 451 and 501 can be specified as values, and you cannot specify a status code more than once.

cdnPolicy.negativeCachingPolicy[].ttl

Optional

integer

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.

cdnPolicy.requestCoalescing

Optional

boolean

If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.

cdnPolicy.serveWhileStale

Optional

integer

Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.

cdnPolicy.signedUrlCacheMaxAgeSec

Optional

integer

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

customResponseHeaders

Optional

list (string)

Headers that the HTTP/S load balancer should add to proxied responses.

customResponseHeaders[]

Optional

string

description

Optional

string

An optional textual description of the resource; provided by the client when the resource is created.

edgeSecurityPolicy

Optional

string

The security policy associated with this backend bucket.

enableCdn

Optional

boolean

If true, enable Cloud CDN for this BackendBucket.

resourceID

Optional

string

Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
creationTimestamp: string
observedGeneration: integer
selfLink: string
Fields
conditions

list (object)

Conditions represent the latest available observation of the resource's current state.

conditions[]

object

conditions[].lastTransitionTime

string

Last time the condition transitioned from one status to another.

conditions[].message

string

Human-readable message indicating details about last transition.

conditions[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.

conditions[].status

string

Status is the status of the condition. Can be True, False, Unknown.

conditions[].type

string

Type is the type of the condition.

creationTimestamp

string

Creation timestamp in RFC3339 text format.

observedGeneration

integer

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.

selfLink

string

Sample YAML(s)

Basic Backend Bucket

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeBackendBucket
metadata:
  name: computebackendbucket-sample-basic
  labels:
    label-one: "value-one"
spec:
  bucketRef:
    name: ${PROJECT_ID?}-backendbucket-dep-basic
  description: contains a reference to a bucket for use with HTTP(S) load-balancing
---
apiVersion: storage.cnrm.cloud.google.com/v1beta1
kind: StorageBucket
metadata:
  # StorageBucket names must be globally unique. Replace ${PROJECT_ID?} with your project ID.
  name: ${PROJECT_ID?}-backendbucket-dep-basic

Cdn Enabled Backend Bucket

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeBackendBucket
metadata:
  name: computebackendbucket-sample-cdnenabled
  labels:
    label-one: "value-one"
spec:
  bucketRef:
    name: ${PROJECT_ID?}-backendbucket-dep-cdn
  description: contains a reference to a bucket for use with HTTP(S) load-balancing and integrated CDN, caching on endpoints for only 1/10th the default time
  enableCdn: true
  cdnPolicy:
    signedUrlCacheMaxAgeSec: 360
---
apiVersion: storage.cnrm.cloud.google.com/v1beta1
kind: StorageBucket
metadata:
  # StorageBucket names must be globally unique. Replace ${PROJECT_ID?} with your project ID.
  name: ${PROJECT_ID?}-backendbucket-dep-cdn