---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# gcp_file_instance{% #gcp_file_instance %}

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `create_time`{% #create_time %}

**Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Output only. The time when the instance was created.

## `custom_performance_supported`{% #custom_performance_supported %}

**Type**: `BOOLEAN`**Provider name**: `customPerformanceSupported`**Description**: Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field.

## `deletion_protection_enabled`{% #deletion_protection_enabled %}

**Type**: `BOOLEAN`**Provider name**: `deletionProtectionEnabled`**Description**: Optional. Indicates whether the instance is protected against deletion.

## `deletion_protection_reason`{% #deletion_protection_reason %}

**Type**: `STRING`**Provider name**: `deletionProtectionReason`**Description**: Optional. The reason for enabling deletion protection.

## `description`{% #description %}

**Type**: `STRING`**Provider name**: `description`**Description**: The description of the instance (2048 characters or less).

## `etag`{% #etag %}

**Type**: `STRING`**Provider name**: `etag`**Description**: Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

## `file_shares`{% #file_shares %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `fileShares`**Description**: File system shares on the instance. For this version, only a single file share is supported.

- `capacity_gb`**Type**: `INT64`**Provider name**: `capacityGb`**Description**: File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes.
- `name`**Type**: `STRING`**Provider name**: `name`**Description**: Required. The name of the file share. Must use 1-16 characters for the basic service tier and 1-63 characters for all other service tiers. Must use lowercase letters, numbers, or underscores `[a-z0-9_]`. Must start with a letter. Immutable.
- `nfs_export_options`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `nfsExportOptions`**Description**: Nfs Export Options. There is a limit of 10 export options per file share.
  - `access_mode`**Type**: `STRING`**Provider name**: `accessMode`**Description**: Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.**Possible values**:
    - `ACCESS_MODE_UNSPECIFIED` - AccessMode not set.
    - `READ_ONLY` - The client can only read the file share.
    - `READ_WRITE` - The client can read and write the file share (default).
  - `anon_gid`**Type**: `INT64`**Provider name**: `anonGid`**Description**: An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
  - `anon_uid`**Type**: `INT64`**Provider name**: `anonUid`**Description**: An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
  - `ip_ranges`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `ipRanges`**Description**: List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
  - `squash_mode`**Type**: `STRING`**Provider name**: `squashMode`**Description**: Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.**Possible values**:
    - `SQUASH_MODE_UNSPECIFIED` - SquashMode not set.
    - `NO_ROOT_SQUASH` - The Root user has root access to the file share (default).
    - `ROOT_SQUASH` - The Root user has squashed access to the anonymous uid/gid.
- `source_backup`**Type**: `STRING`**Provider name**: `sourceBackup`**Description**: The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from.

## `kms_key_name`{% #kms_key_name %}

**Type**: `STRING`**Provider name**: `kmsKeyName`**Description**: KMS key name used for data encryption.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Output only. The resource name of the instance, in the format `projects/{project}/locations/{location}/instances/{instance}`.

## `networks`{% #networks %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `networks`**Description**: VPC networks to which the instance is connected. For this version, only a single network is supported.

- `connect_mode`**Type**: `STRING`**Provider name**: `connectMode`**Description**: The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.**Possible values**:
  - `CONNECT_MODE_UNSPECIFIED` - Not set.
  - `DIRECT_PEERING` - Connect via direct peering to the Filestore service.
  - `PRIVATE_SERVICE_ACCESS` - Connect to your Filestore instance using Private Service Access. Private services access provides an IP address range for multiple Google Cloud services, including Filestore.
- `ip_addresses`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `ipAddresses`**Description**: Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.
- `modes`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `modes`**Description**: Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
- `network`**Type**: `STRING`**Provider name**: `network`**Description**: The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.
- `reserved_ip_range`**Type**: `STRING`**Provider name**: `reservedIpRange`**Description**: Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `performance_config`{% #performance_config %}

**Type**: `STRUCT`**Provider name**: `performanceConfig`**Description**: Optional. Used to configure performance.

- `fixed_iops`**Type**: `STRUCT`**Provider name**: `fixedIops`**Description**: Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error.
  - `max_iops`**Type**: `INT64`**Provider name**: `maxIops`**Description**: Required. Maximum IOPS.
- `iops_per_tb`**Type**: `STRUCT`**Provider name**: `iopsPerTb`**Description**: Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error.
  - `max_iops_per_tb`**Type**: `INT64`**Provider name**: `maxIopsPerTb`**Description**: Required. Maximum IOPS per TiB.

## `performance_limits`{% #performance_limits %}

**Type**: `STRUCT`**Provider name**: `performanceLimits`**Description**: Output only. Used for getting performance limits.

- `max_iops`**Type**: `INT64`**Provider name**: `maxIops`**Description**: Output only. The max IOPS.
- `max_read_iops`**Type**: `INT64`**Provider name**: `maxReadIops`**Description**: Output only. The max read IOPS.
- `max_read_throughput_bps`**Type**: `INT64`**Provider name**: `maxReadThroughputBps`**Description**: Output only. The max read throughput in bytes per second.
- `max_write_iops`**Type**: `INT64`**Provider name**: `maxWriteIops`**Description**: Output only. The max write IOPS.
- `max_write_throughput_bps`**Type**: `INT64`**Provider name**: `maxWriteThroughputBps`**Description**: Output only. The max write throughput in bytes per second.

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `protocol`{% #protocol %}

**Type**: `STRING`**Provider name**: `protocol`**Description**: 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`.**Possible values**:

- `FILE_PROTOCOL_UNSPECIFIED` - FILE_PROTOCOL_UNSPECIFIED serves a 'not set' default value when a FileProtocol is a separate field in a message.
- `NFS_V3` - NFS 3.0.
- `NFS_V4_1` - NFS 4.1.

## `region_id`{% #region_id %}

**Type**: `STRING`

## `replication`{% #replication %}

**Type**: `STRUCT`**Provider name**: `replication`**Description**: Optional. Replication configuration.

- `replicas`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `replicas`**Description**: Optional. Replication configuration for the replica instance associated with this instance. Only a single replica is supported.
  - `last_active_sync_time`**Type**: `TIMESTAMP`**Provider name**: `lastActiveSyncTime`**Description**: Output only. The timestamp of the latest replication snapshot taken on the active instance and is already replicated safely.
  - `peer_instance`**Type**: `STRING`**Provider name**: `peerInstance`**Description**: Optional. The peer instance.
  - `state`**Type**: `STRING`**Provider name**: `state`**Description**: Output only. The replica state.**Possible values**:
    - `STATE_UNSPECIFIED` - State not set.
    - `CREATING` - The replica is being created.
    - `READY` - The replica is ready.
    - `REMOVING` - The replica is being removed.
    - `FAILED` - The replica is experiencing an issue and might be unusable. You can get further details from the `stateReasons` field of the `ReplicaConfig` object.
  - `state_reasons`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `stateReasons`**Description**: Output only. Additional information about the replication state, if available.
- `role`**Type**: `STRING`**Provider name**: `role`**Description**: Optional. The replication role.**Possible values**:
  - `ROLE_UNSPECIFIED` - Role not set.
  - `ACTIVE` - The instance is the `ACTIVE` replication member, functions as the replication source instance.
  - `STANDBY` - The instance is the `STANDBY` replication member, functions as the replication destination instance.

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `satisfies_pzi`{% #satisfies_pzi %}

**Type**: `BOOLEAN`**Provider name**: `satisfiesPzi`**Description**: Output only. Reserved for future use.

## `satisfies_pzs`{% #satisfies_pzs %}

**Type**: `BOOLEAN`**Provider name**: `satisfiesPzs`**Description**: Output only. Reserved for future use.

## `state`{% #state %}

**Type**: `STRING`**Provider name**: `state`**Description**: Output only. The instance state.**Possible values**:

- `STATE_UNSPECIFIED` - State not set.
- `CREATING` - The instance is being created.
- `READY` - The instance is available for use.
- `REPAIRING` - Work is being done on the instance. You can get further details from the `statusMessage` field of the `Instance` resource.
- `DELETING` - The instance is shutting down.
- `ERROR` - The instance is experiencing an issue and might be unusable. You can get further details from the `statusMessage` field of the `Instance` resource.
- `RESTORING` - The instance is restoring a backup to an existing file share and may be unusable during this time.
- `SUSPENDED` - The instance is suspended. You can get further details from the `suspension_reasons` field of the `Instance` resource.
- `SUSPENDING` - The instance is in the process of becoming suspended.
- `RESUMING` - The instance is in the process of becoming active.
- `REVERTING` - The instance is reverting to a snapshot.
- `PROMOTING` - The replica instance is being promoted.

## `status_message`{% #status_message %}

**Type**: `STRING`**Provider name**: `statusMessage`**Description**: Output only. Additional information about the instance state, if available.

## `suspension_reasons`{% #suspension_reasons %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `suspensionReasons`**Description**: Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `tier`{% #tier %}

**Type**: `STRING`**Provider name**: `tier`**Description**: The service tier of the instance.**Possible values**:

- `TIER_UNSPECIFIED` - Not set.
- `STANDARD` - STANDARD tier. BASIC_HDD is the preferred term for this tier.
- `PREMIUM` - PREMIUM tier. BASIC_SSD is the preferred term for this tier.
- `BASIC_HDD` - BASIC instances offer a maximum capacity of 63.9 TB. BASIC_HDD is an alias for STANDARD Tier, offering economical performance backed by HDD.
- `BASIC_SSD` - BASIC instances offer a maximum capacity of 63.9 TB. BASIC_SSD is an alias for PREMIUM Tier, and offers improved performance backed by SSD.
- `HIGH_SCALE_SSD` - HIGH_SCALE instances offer expanded capacity and performance scaling capabilities.
- `ENTERPRISE` - ENTERPRISE instances offer the features and availability needed for mission-critical workloads.
- `ZONAL` - ZONAL instances offer expanded capacity and performance scaling capabilities.
- `REGIONAL` - REGIONAL instances offer the features and availability needed for mission-critical workloads.

## `zone_id`{% #zone_id %}

**Type**: `STRING`