FilestoreBackup


Property Value
Google Cloud Service Name Cloud Filestore
Google Cloud Service Documentation /filestore/docs
Google Cloud REST Resource Name v1beta1.projects.locations.backups
Google Cloud REST Resource Documentation /filestore/docs/reference/rest/v1beta1/projects.locations.backups
Config Connector Resource Short Names gcpfilestorebackup
gcpfilestorebackups
filestorebackup
Config Connector Service Name file.googleapis.com
Config Connector Resource Fully Qualified Name filestorebackups.filestore.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No
Config Connector Default Average Reconcile Interval In Seconds 600

Custom Resource Definition Properties

Spec

Schema

  description 
 : 
  
 string 
 location 
 : 
  
 string 
 projectRef 
 : 
  
 external 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 namespace 
 : 
  
 string 
 resourceID 
 : 
  
 string 
 sourceFileShare 
 : 
  
 string 
 sourceInstanceRef 
 : 
  
 external 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 namespace 
 : 
  
 string 
 
Fields

description

Optional

string

A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.

location

Required

string

Immutable. The location for the resource

projectRef

Required

object

Immutable. The Project that this resource belongs to.

projectRef.external

Optional

string

The project for the resource Allowed value: The Google Cloud resource name of a `Project` resource (format: `projects/{{name}}`).

projectRef.name

Optional

string

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

projectRef.namespace

Optional

string

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

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.

sourceFileShare

Required

string

Immutable. Name of the file share in the source Cloud Filestore instance that the backup is created from.

sourceInstanceRef

Required

object

Immutable.

sourceInstanceRef.external

Optional

string

The resource name of the source Cloud Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup. Allowed value: The Google Cloud resource name of a `FilestoreInstance` resource (format: `projects/{{project}}/locations/{{location}}/instances/{{name}}`).

sourceInstanceRef.name

Optional

string

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

sourceInstanceRef.namespace

Optional

string

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

Status

Schema

  capacityGb 
 : 
  
 integer 
 conditions 
 : 
 - 
  
 lastTransitionTime 
 : 
  
 string 
  
 message 
 : 
  
 string 
  
 reason 
 : 
  
 string 
  
 status 
 : 
  
 string 
  
 type 
 : 
  
 string 
 createTime 
 : 
  
 string 
 downloadBytes 
 : 
  
 integer 
 observedGeneration 
 : 
  
 integer 
 sourceInstanceTier 
 : 
  
 string 
 state 
 : 
  
 string 
 storageBytes 
 : 
  
 integer 
 
Fields
capacityGb

integer

Output only. Capacity of the source file share when the backup was created.

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.

createTime

string

Output only. The time when the backup was created.

downloadBytes

integer

Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.

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.

sourceInstanceTier

string

Output only. The service tier of the source Cloud Filestore instance that this backup is created from. Possible values: TIER_UNSPECIFIED, STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD

state

string

Output only. The backup state. Possible values: STATE_UNSPECIFIED, CREATING, READY, REPAIRING, DELETING, ERROR, RESTORING

storageBytes

integer

Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.

Sample YAML(s)

Typical Use Case

  # 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 
 : 
  
 filestore.cnrm.cloud.google.com/v1beta1 
 kind 
 : 
  
 FilestoreBackup 
 metadata 
 : 
  
 name 
 : 
  
 filestorebackup-sample 
 spec 
 : 
  
 projectRef 
 : 
  
 # Replace ${PROJECT_ID?} with your project ID 
  
 external 
 : 
  
 "projects/${PROJECT_ID?}" 
  
 description 
 : 
  
 "A 
  
 sample 
  
 backup" 
  
 location 
 : 
  
 us-central1 
  
 sourceFileShare 
 : 
  
 my_share 
  
 sourceInstanceRef 
 : 
  
 name 
 : 
  
 filestorebackup-dep 
 --- 
 apiVersion 
 : 
  
 compute.cnrm.cloud.google.com/v1beta1 
 kind 
 : 
  
 ComputeNetwork 
 metadata 
 : 
  
 name 
 : 
  
 filestorebackup-dep 
 spec 
 : 
  
 autoCreateSubnetworks 
 : 
  
 false 
 --- 
 apiVersion 
 : 
  
 filestore.cnrm.cloud.google.com/v1beta1 
 kind 
 : 
  
 FilestoreInstance 
 metadata 
 : 
  
 name 
 : 
  
 filestorebackup-dep 
 spec 
 : 
  
 projectRef 
 : 
  
 # Replace ${PROJECT_ID?} with your project ID 
  
 external 
 : 
  
 "projects/${PROJECT_ID?}" 
  
 description 
 : 
  
 "Sample 
  
 FilestoreInstance 
  
 dependency 
  
 for 
  
 FilestoreBackup" 
  
 fileShares 
 : 
  
 - 
  
 capacityGb 
 : 
  
 4800 
  
 name 
 : 
  
 my_share 
  
 location 
 : 
  
 us-central1-c 
  
 networks 
 : 
  
 - 
  
 modes 
 : 
  
 - 
  
 MODE_IPV4 
  
 networkRef 
 : 
  
 name 
 : 
  
 filestorebackup-dep 
  
 reservedIPRange 
 : 
  
 10.0.0.0/29 
  
 tier 
 : 
  
 PREMIUM 
 
Create a Mobile Website
View Site in Mobile | Classic
Share by: