instances

Creates, updates, deletes, gets or lists a instances resource.

Overview

Name	instances
Type	Resource
Id	google.file.instances

Fields

Name	Datatype	Description
name	string	Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.
description	string	The description of the instance (2048 characters or less).
configurablePerformanceEnabled	boolean	Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field.
createTime	string	Output only. The time when the instance was created.
deletionProtectionEnabled	boolean	Optional. Indicates whether the instance is protected against deletion.
deletionProtectionReason	string	Optional. The reason for enabling deletion protection.
etag	string	Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
fileShares	array	File system shares on the instance. For this version, only a single file share is supported.
kmsKeyName	string	KMS key name used for data encryption.
labels	object	Resource labels to represent user provided metadata.
networks	array	VPC networks to which the instance is connected. For this version, only a single network is supported.
performanceConfig	object	Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively).
performanceLimits	object	The enforced performance limits, calculated from the instance's performance configuration.
protocol	string	Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: NFS_V3.
replication	object	Replication specifications.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The instance state.
statusMessage	string	Output only. Additional information about the instance state, if available.
suspensionReasons	array	Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.
tags	object	Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
tier	string	The service tier of the instance.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	instancesId, locationsId, projectsId	Gets the details of a specific instance.
list	SELECT	locationsId, projectsId	Lists all instances in a project for either a specified location or for all locations.
create	INSERT	locationsId, projectsId	Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
delete	DELETE	instancesId, locationsId, projectsId	Deletes an instance.
patch	UPDATE	instancesId, locationsId, projectsId	Updates the settings of a specific instance.
promote_replica	EXEC	instancesId, locationsId, projectsId	Promote the standby instance (replica).
restore	EXEC	instancesId, locationsId, projectsId	Restores an existing instance's file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
revert	EXEC	instancesId, locationsId, projectsId	Revert an existing instance's file system to a specified snapshot.

SELECT examples

Lists all instances in a project for either a specified location or for all locations.

SELECT
name,
description,
configurablePerformanceEnabled,
createTime,
deletionProtectionEnabled,
deletionProtectionReason,
etag,
fileShares,
kmsKeyName,
labels,
networks,
performanceConfig,
performanceLimits,
protocol,
replication,
satisfiesPzi,
satisfiesPzs,
state,
statusMessage,
suspensionReasons,
tags,
tier
FROM google.file.instances
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new instances resource.

All Properties

/*+ create */
INSERT INTO google.file.instances (
locationsId,
projectsId,
description,
tier,
labels,
fileShares,
networks,
etag,
kmsKeyName,
replication,
tags,
protocol,
performanceConfig,
deletionProtectionEnabled,
deletionProtectionReason
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ description }}',
'{{ tier }}',
'{{ labels }}',
'{{ fileShares }}',
'{{ networks }}',
'{{ etag }}',
'{{ kmsKeyName }}',
'{{ replication }}',
'{{ tags }}',
'{{ protocol }}',
'{{ performanceConfig }}',
{{ deletionProtectionEnabled }},
'{{ deletionProtectionReason }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: description
      value: string
    - name: state
      value: string
    - name: statusMessage
      value: string
    - name: createTime
      value: string
    - name: tier
      value: string
    - name: labels
      value: object
    - name: fileShares
      value:
        - - name: name
            value: string
          - name: capacityGb
            value: string
          - name: sourceBackup
            value: string
          - name: nfsExportOptions
            value:
              - - name: ipRanges
                  value:
                    - string
                - name: accessMode
                  value: string
                - name: squashMode
                  value: string
                - name: anonUid
                  value: string
                - name: anonGid
                  value: string
    - name: networks
      value:
        - - name: network
            value: string
          - name: modes
            value:
              - string
          - name: reservedIpRange
            value: string
          - name: ipAddresses
            value:
              - string
          - name: connectMode
            value: string
    - name: etag
      value: string
    - name: satisfiesPzs
      value: boolean
    - name: satisfiesPzi
      value: boolean
    - name: kmsKeyName
      value: string
    - name: suspensionReasons
      value:
        - string
    - name: replication
      value:
        - name: role
          value: string
        - name: replicas
          value:
            - - name: state
                value: string
              - name: stateReasons
                value:
                  - string
              - name: peerInstance
                value: string
              - name: lastActiveSyncTime
                value: string
    - name: tags
      value: object
    - name: protocol
      value: string
    - name: configurablePerformanceEnabled
      value: boolean
    - name: performanceConfig
      value:
        - name: fixedIops
          value:
            - name: maxReadIops
              value: string
        - name: iopsPerTb
          value:
            - name: maxReadIopsPerTb
              value: string
    - name: performanceLimits
      value:
        - name: maxReadIops
          value: string
        - name: maxWriteIops
          value: string
        - name: maxReadThroughputBps
          value: string
        - name: maxWriteThroughputBps
          value: string
    - name: deletionProtectionEnabled
      value: boolean
    - name: deletionProtectionReason
      value: string

UPDATE example

Updates a instances resource.

/*+ update */
UPDATE google.file.instances
SET 
description = '{{ description }}',
tier = '{{ tier }}',
labels = '{{ labels }}',
fileShares = '{{ fileShares }}',
networks = '{{ networks }}',
etag = '{{ etag }}',
kmsKeyName = '{{ kmsKeyName }}',
replication = '{{ replication }}',
tags = '{{ tags }}',
protocol = '{{ protocol }}',
performanceConfig = '{{ performanceConfig }}',
deletionProtectionEnabled = true|false,
deletionProtectionReason = '{{ deletionProtectionReason }}'
WHERE 
instancesId = '{{ instancesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified instances resource.

/*+ delete */
DELETE FROM google.file.instances
WHERE instancesId = '{{ instancesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';