Skip to content

compute.v1beta1.backendBucket

"BackendBucket is the Schema for the BackendBuckets API. Backend buckets allow you to use Google Cloud Storage buckets with HTTP(S) load balancing."

Index

Fields

fn new

new(name)

new returns an instance of BackendBucket

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"BackendBucketSpec defines the desired state of BackendBucket"

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"

fn spec.withManagementPolicies

withManagementPolicies(managementPolicies)

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

fn spec.withManagementPoliciesMixin

withManagementPoliciesMixin(managementPolicies)

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

Note: This function appends passed data to existing values

obj spec.forProvider

fn spec.forProvider.withBucketName

withBucketName(bucketName)

"Cloud Storage bucket name."

fn spec.forProvider.withCdnPolicy

withCdnPolicy(cdnPolicy)

"Cloud CDN configuration for this Backend Bucket. Structure is documented below."

fn spec.forProvider.withCdnPolicyMixin

withCdnPolicyMixin(cdnPolicy)

"Cloud CDN configuration for this Backend Bucket. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withCompressionMode

withCompressionMode(compressionMode)

"Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED."

fn spec.forProvider.withCustomResponseHeaders

withCustomResponseHeaders(customResponseHeaders)

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

fn spec.forProvider.withCustomResponseHeadersMixin

withCustomResponseHeadersMixin(customResponseHeaders)

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

Note: This function appends passed data to existing values

fn spec.forProvider.withDescription

withDescription(description)

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

fn spec.forProvider.withEdgeSecurityPolicy

withEdgeSecurityPolicy(edgeSecurityPolicy)

"The security policy associated with this backend bucket."

fn spec.forProvider.withEnableCdn

withEnableCdn(enableCdn)

"If true, enable Cloud CDN for this BackendBucket."

fn spec.forProvider.withProject

withProject(project)

"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."

obj spec.forProvider.bucketNameRef

"Reference to a Bucket in storage to populate bucketName."

fn spec.forProvider.bucketNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.bucketNameRef.policy

"Policies for referencing."

fn spec.forProvider.bucketNameRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.bucketNameRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.bucketNameSelector

"Selector for a Bucket in storage to populate bucketName."

fn spec.forProvider.bucketNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.bucketNameSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.bucketNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.bucketNameSelector.policy

"Policies for selection."

fn spec.forProvider.bucketNameSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.bucketNameSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.cdnPolicy

"Cloud CDN configuration for this Backend Bucket. Structure is documented below."

fn spec.forProvider.cdnPolicy.withBypassCacheOnRequestHeaders

withBypassCacheOnRequestHeaders(bypassCacheOnRequestHeaders)

"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. Structure is documented below."

fn spec.forProvider.cdnPolicy.withBypassCacheOnRequestHeadersMixin

withBypassCacheOnRequestHeadersMixin(bypassCacheOnRequestHeaders)

"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. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.cdnPolicy.withCacheKeyPolicy

withCacheKeyPolicy(cacheKeyPolicy)

"The CacheKeyPolicy for this CdnPolicy. Structure is documented below."

fn spec.forProvider.cdnPolicy.withCacheKeyPolicyMixin

withCacheKeyPolicyMixin(cacheKeyPolicy)

"The CacheKeyPolicy for this CdnPolicy. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.cdnPolicy.withCacheMode

withCacheMode(cacheMode)

"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 are: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL, CACHE_ALL_STATIC."

fn spec.forProvider.cdnPolicy.withClientTtl

withClientTtl(clientTtl)

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

fn spec.forProvider.cdnPolicy.withDefaultTtl

withDefaultTtl(defaultTtl)

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

fn spec.forProvider.cdnPolicy.withMaxTtl

withMaxTtl(maxTtl)

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

fn spec.forProvider.cdnPolicy.withNegativeCaching

withNegativeCaching(negativeCaching)

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

fn spec.forProvider.cdnPolicy.withNegativeCachingPolicy

withNegativeCachingPolicy(negativeCachingPolicy)

"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. Structure is documented below."

fn spec.forProvider.cdnPolicy.withNegativeCachingPolicyMixin

withNegativeCachingPolicyMixin(negativeCachingPolicy)

"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. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.cdnPolicy.withRequestCoalescing

withRequestCoalescing(requestCoalescing)

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

fn spec.forProvider.cdnPolicy.withServeWhileStale

withServeWhileStale(serveWhileStale)

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

fn spec.forProvider.cdnPolicy.withSignedUrlCacheMaxAgeSec

withSignedUrlCacheMaxAgeSec(signedUrlCacheMaxAgeSec)

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

obj spec.forProvider.cdnPolicy.bypassCacheOnRequestHeaders

"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. Structure is documented below."

fn spec.forProvider.cdnPolicy.bypassCacheOnRequestHeaders.withHeaderName

withHeaderName(headerName)

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

obj spec.forProvider.cdnPolicy.cacheKeyPolicy

"The CacheKeyPolicy for this CdnPolicy. Structure is documented below."

fn spec.forProvider.cdnPolicy.cacheKeyPolicy.withIncludeHttpHeaders

withIncludeHttpHeaders(includeHttpHeaders)

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

fn spec.forProvider.cdnPolicy.cacheKeyPolicy.withIncludeHttpHeadersMixin

withIncludeHttpHeadersMixin(includeHttpHeaders)

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

Note: This function appends passed data to existing values

fn spec.forProvider.cdnPolicy.cacheKeyPolicy.withQueryStringWhitelist

withQueryStringWhitelist(queryStringWhitelist)

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

fn spec.forProvider.cdnPolicy.cacheKeyPolicy.withQueryStringWhitelistMixin

withQueryStringWhitelistMixin(queryStringWhitelist)

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

Note: This function appends passed data to existing values

obj spec.forProvider.cdnPolicy.negativeCachingPolicy

"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. Structure is documented below."

fn spec.forProvider.cdnPolicy.negativeCachingPolicy.withCode

withCode(code)

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

fn spec.forProvider.cdnPolicy.negativeCachingPolicy.withTtl

withTtl(ttl)

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

obj spec.forProvider.edgeSecurityPolicyRef

"Reference to a SecurityPolicy in compute to populate edgeSecurityPolicy."

fn spec.forProvider.edgeSecurityPolicyRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.edgeSecurityPolicyRef.policy

"Policies for referencing."

fn spec.forProvider.edgeSecurityPolicyRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.edgeSecurityPolicyRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.edgeSecurityPolicySelector

"Selector for a SecurityPolicy in compute to populate edgeSecurityPolicy."

fn spec.forProvider.edgeSecurityPolicySelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.edgeSecurityPolicySelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.edgeSecurityPolicySelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.edgeSecurityPolicySelector.policy

"Policies for selection."

fn spec.forProvider.edgeSecurityPolicySelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.edgeSecurityPolicySelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.initProvider

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler."

fn spec.initProvider.withCdnPolicy

withCdnPolicy(cdnPolicy)

"Cloud CDN configuration for this Backend Bucket. Structure is documented below."

fn spec.initProvider.withCdnPolicyMixin

withCdnPolicyMixin(cdnPolicy)

"Cloud CDN configuration for this Backend Bucket. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withCompressionMode

withCompressionMode(compressionMode)

"Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED."

fn spec.initProvider.withCustomResponseHeaders

withCustomResponseHeaders(customResponseHeaders)

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

fn spec.initProvider.withCustomResponseHeadersMixin

withCustomResponseHeadersMixin(customResponseHeaders)

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

Note: This function appends passed data to existing values

fn spec.initProvider.withDescription

withDescription(description)

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

fn spec.initProvider.withEnableCdn

withEnableCdn(enableCdn)

"If true, enable Cloud CDN for this BackendBucket."

fn spec.initProvider.withProject

withProject(project)

"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."

obj spec.initProvider.cdnPolicy

"Cloud CDN configuration for this Backend Bucket. Structure is documented below."

fn spec.initProvider.cdnPolicy.withBypassCacheOnRequestHeaders

withBypassCacheOnRequestHeaders(bypassCacheOnRequestHeaders)

"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. Structure is documented below."

fn spec.initProvider.cdnPolicy.withBypassCacheOnRequestHeadersMixin

withBypassCacheOnRequestHeadersMixin(bypassCacheOnRequestHeaders)

"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. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.cdnPolicy.withCacheKeyPolicy

withCacheKeyPolicy(cacheKeyPolicy)

"The CacheKeyPolicy for this CdnPolicy. Structure is documented below."

fn spec.initProvider.cdnPolicy.withCacheKeyPolicyMixin

withCacheKeyPolicyMixin(cacheKeyPolicy)

"The CacheKeyPolicy for this CdnPolicy. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.cdnPolicy.withCacheMode

withCacheMode(cacheMode)

"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 are: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL, CACHE_ALL_STATIC."

fn spec.initProvider.cdnPolicy.withClientTtl

withClientTtl(clientTtl)

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

fn spec.initProvider.cdnPolicy.withDefaultTtl

withDefaultTtl(defaultTtl)

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

fn spec.initProvider.cdnPolicy.withMaxTtl

withMaxTtl(maxTtl)

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

fn spec.initProvider.cdnPolicy.withNegativeCaching

withNegativeCaching(negativeCaching)

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

fn spec.initProvider.cdnPolicy.withNegativeCachingPolicy

withNegativeCachingPolicy(negativeCachingPolicy)

"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. Structure is documented below."

fn spec.initProvider.cdnPolicy.withNegativeCachingPolicyMixin

withNegativeCachingPolicyMixin(negativeCachingPolicy)

"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. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.cdnPolicy.withRequestCoalescing

withRequestCoalescing(requestCoalescing)

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

fn spec.initProvider.cdnPolicy.withServeWhileStale

withServeWhileStale(serveWhileStale)

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

fn spec.initProvider.cdnPolicy.withSignedUrlCacheMaxAgeSec

withSignedUrlCacheMaxAgeSec(signedUrlCacheMaxAgeSec)

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

obj spec.initProvider.cdnPolicy.bypassCacheOnRequestHeaders

"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. Structure is documented below."

fn spec.initProvider.cdnPolicy.bypassCacheOnRequestHeaders.withHeaderName

withHeaderName(headerName)

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

obj spec.initProvider.cdnPolicy.cacheKeyPolicy

"The CacheKeyPolicy for this CdnPolicy. Structure is documented below."

fn spec.initProvider.cdnPolicy.cacheKeyPolicy.withIncludeHttpHeaders

withIncludeHttpHeaders(includeHttpHeaders)

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

fn spec.initProvider.cdnPolicy.cacheKeyPolicy.withIncludeHttpHeadersMixin

withIncludeHttpHeadersMixin(includeHttpHeaders)

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

Note: This function appends passed data to existing values

fn spec.initProvider.cdnPolicy.cacheKeyPolicy.withQueryStringWhitelist

withQueryStringWhitelist(queryStringWhitelist)

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

fn spec.initProvider.cdnPolicy.cacheKeyPolicy.withQueryStringWhitelistMixin

withQueryStringWhitelistMixin(queryStringWhitelist)

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

Note: This function appends passed data to existing values

obj spec.initProvider.cdnPolicy.negativeCachingPolicy

"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. Structure is documented below."

fn spec.initProvider.cdnPolicy.negativeCachingPolicy.withCode

withCode(code)

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

fn spec.initProvider.cdnPolicy.negativeCachingPolicy.withTtl

withTtl(ttl)

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

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef.policy

"Policies for referencing."

fn spec.providerRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."