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

# gcp_netapp_volume{% #gcp_netapp_volume %}

## `active_directory`{% #active_directory %}

**Type**: `STRING`**Provider name**: `activeDirectory`**Description**: Output only. Specifies the ActiveDirectory name of a SMB volume.

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `backup_config`{% #backup_config %}

**Type**: `STRUCT`**Provider name**: `backupConfig`**Description**: BackupConfig of the volume.

- `backup_chain_bytes`**Type**: `INT64`**Provider name**: `backupChainBytes`**Description**: Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
- `backup_policies`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `backupPolicies`**Description**: Optional. When specified, schedule backups will be created based on the policy configuration.
- `backup_vault`**Type**: `STRING`**Provider name**: `backupVault`**Description**: Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
- `scheduled_backup_enabled`**Type**: `BOOLEAN`**Provider name**: `scheduledBackupEnabled`**Description**: Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.

## `capacity_gib`{% #capacity_gib %}

**Type**: `INT64`**Provider name**: `capacityGib`**Description**: Required. Capacity in GIB of the volume

## `cold_tier_size_gib`{% #cold_tier_size_gib %}

**Type**: `INT64`**Provider name**: `coldTierSizeGib`**Description**: Output only. Size of the volume cold tier data in GiB.

## `create_time`{% #create_time %}

**Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Output only. Create time of the volume

## `description`{% #description %}

**Type**: `STRING`**Provider name**: `description`**Description**: Optional. Description of the volume

## `encryption_type`{% #encryption_type %}

**Type**: `STRING`**Provider name**: `encryptionType`**Description**: Output only. Specified the current volume encryption key source.**Possible values**:

- `ENCRYPTION_TYPE_UNSPECIFIED` - The source of the encryption key is not specified.
- `SERVICE_MANAGED` - Google managed encryption key.
- `CLOUD_KMS` - Customer managed encryption key, which is stored in KMS.

## `export_policy`{% #export_policy %}

**Type**: `STRUCT`**Provider name**: `exportPolicy`**Description**: Optional. Export policy of the volume

- `rules`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `rules`**Description**: Required. List of export policy rules
  - `access_type`**Type**: `STRING`**Provider name**: `accessType`**Description**: Access type (ReadWrite, ReadOnly, None)**Possible values**:
    - `ACCESS_TYPE_UNSPECIFIED` - Unspecified Access Type
    - `READ_ONLY` - Read Only
    - `READ_WRITE` - Read Write
    - `READ_NONE` - None
  - `allowed_clients`**Type**: `STRING`**Provider name**: `allowedClients`**Description**: Comma separated list of allowed clients IP addresses
  - `has_root_access`**Type**: `STRING`**Provider name**: `hasRootAccess`**Description**: Whether Unix root access will be granted.
  - `kerberos5_read_only`**Type**: `BOOLEAN`**Provider name**: `kerberos5ReadOnly`**Description**: If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
  - `kerberos5_read_write`**Type**: `BOOLEAN`**Provider name**: `kerberos5ReadWrite`**Description**: If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.
  - `kerberos5i_read_only`**Type**: `BOOLEAN`**Provider name**: `kerberos5iReadOnly`**Description**: If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
  - `kerberos5i_read_write`**Type**: `BOOLEAN`**Provider name**: `kerberos5iReadWrite`**Description**: If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.
  - `kerberos5p_read_only`**Type**: `BOOLEAN`**Provider name**: `kerberos5pReadOnly`**Description**: If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
  - `kerberos5p_read_write`**Type**: `BOOLEAN`**Provider name**: `kerberos5pReadWrite`**Description**: If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.
  - `nfsv3`**Type**: `BOOLEAN`**Provider name**: `nfsv3`**Description**: NFS V3 protocol.
  - `nfsv4`**Type**: `BOOLEAN`**Provider name**: `nfsv4`**Description**: NFS V4 protocol.

## `has_replication`{% #has_replication %}

**Type**: `BOOLEAN`**Provider name**: `hasReplication`**Description**: Output only. Indicates whether the volume is part of a replication relationship.

## `hybrid_replication_parameters`{% #hybrid_replication_parameters %}

**Type**: `STRUCT`**Provider name**: `hybridReplicationParameters`**Description**: Optional. The Hybrid Replication parameters for the volume.

- `cluster_location`**Type**: `STRING`**Provider name**: `clusterLocation`**Description**: Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only.
- `description`**Type**: `STRING`**Provider name**: `description`**Description**: Optional. Description of the replication.
- `peer_cluster_name`**Type**: `STRING`**Provider name**: `peerClusterName`**Description**: Required. Name of the user's local source cluster to be peered with the destination cluster.
- `peer_ip_addresses`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `peerIpAddresses`**Description**: Required. List of node ip addresses to be peered with.
- `peer_svm_name`**Type**: `STRING`**Provider name**: `peerSvmName`**Description**: Required. Name of the user's local source vserver svm to be peered with the destination vserver svm.
- `peer_volume_name`**Type**: `STRING`**Provider name**: `peerVolumeName`**Description**: Required. Name of the user's local source volume to be peered with the destination volume.
- `replication`**Type**: `STRING`**Provider name**: `replication`**Description**: Required. Desired name for the replication of this volume.

## `kerberos_enabled`{% #kerberos_enabled %}

**Type**: `BOOLEAN`**Provider name**: `kerberosEnabled`**Description**: Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).

## `kms_config`{% #kms_config %}

**Type**: `STRING`**Provider name**: `kmsConfig`**Description**: Output only. Specifies the KMS config to be used for volume encryption.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `large_capacity`{% #large_capacity %}

**Type**: `BOOLEAN`**Provider name**: `largeCapacity`**Description**: Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.

## `ldap_enabled`{% #ldap_enabled %}

**Type**: `BOOLEAN`**Provider name**: `ldapEnabled`**Description**: Output only. Flag indicating if the volume is NFS LDAP enabled or not.

## `mount_options`{% #mount_options %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `mountOptions`**Description**: Output only. Mount options of this volume

- `export`**Type**: `STRING`**Provider name**: `export`**Description**: Export string
- `export_full`**Type**: `STRING`**Provider name**: `exportFull`**Description**: Full export string
- `instructions`**Type**: `STRING`**Provider name**: `instructions`**Description**: Instructions for mounting
- `ip_address`**Type**: `STRING`**Provider name**: `ipAddress`**Description**: Output only. IP Address.
- `protocol`**Type**: `STRING`**Provider name**: `protocol`**Description**: Protocol to mount with.**Possible values**:
  - `PROTOCOLS_UNSPECIFIED` - Unspecified protocol
  - `NFSV3` - NFS V3 protocol
  - `NFSV4` - NFS V4 protocol
  - `SMB` - SMB protocol

## `multiple_endpoints`{% #multiple_endpoints %}

**Type**: `BOOLEAN`**Provider name**: `multipleEndpoints`**Description**: Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Identifier. Name of the volume

## `network`{% #network %}

**Type**: `STRING`**Provider name**: `network`**Description**: Output only. VPC Network name. Format: projects/{project}/global/networks/{network}

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `protocols`{% #protocols %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `protocols`**Description**: Required. Protocols required for the volume

## `psa_range`{% #psa_range %}

**Type**: `STRING`**Provider name**: `psaRange`**Description**: Output only. This field is not implemented. The values provided in this field are ignored.

## `region_id`{% #region_id %}

**Type**: `STRING`

## `replica_zone`{% #replica_zone %}

**Type**: `STRING`**Provider name**: `replicaZone`**Description**: Output only. Specifies the replica zone for regional volume.

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `restore_parameters`{% #restore_parameters %}

**Type**: `STRUCT`**Provider name**: `restoreParameters`**Description**: Optional. Specifies the source of the volume to be created from.

- `source_backup`**Type**: `STRING`**Provider name**: `sourceBackup`**Description**: Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
- `source_snapshot`**Type**: `STRING`**Provider name**: `sourceSnapshot`**Description**: Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}

## `restricted_actions`{% #restricted_actions %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `restrictedActions`**Description**: Optional. List of actions that are restricted on this volume.

## `security_style`{% #security_style %}

**Type**: `STRING`**Provider name**: `securityStyle`**Description**: Optional. Security Style of the Volume**Possible values**:

- `SECURITY_STYLE_UNSPECIFIED` - SecurityStyle is unspecified
- `NTFS` - SecurityStyle uses NTFS
- `UNIX` - SecurityStyle uses UNIX

## `service_level`{% #service_level %}

**Type**: `STRING`**Provider name**: `serviceLevel`**Description**: Output only. Service level of the volume**Possible values**:

- `SERVICE_LEVEL_UNSPECIFIED` - Unspecified service level.
- `PREMIUM` - Premium service level.
- `EXTREME` - Extreme service level.
- `STANDARD` - Standard service level.
- `FLEX` - Flex service level.

## `share_name`{% #share_name %}

**Type**: `STRING`**Provider name**: `shareName`**Description**: Required. Share name of the volume

## `smb_settings`{% #smb_settings %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `smbSettings`**Description**: Optional. SMB share settings for the volume.

## `snap_reserve`{% #snap_reserve %}

**Type**: `DOUBLE`**Provider name**: `snapReserve`**Description**: Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.

## `snapshot_directory`{% #snapshot_directory %}

**Type**: `BOOLEAN`**Provider name**: `snapshotDirectory`**Description**: Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.

## `snapshot_policy`{% #snapshot_policy %}

**Type**: `STRUCT`**Provider name**: `snapshotPolicy`**Description**: Optional. SnapshotPolicy for a volume.

- `daily_schedule`**Type**: `STRUCT`**Provider name**: `dailySchedule`**Description**: Daily schedule policy.
  - `hour`**Type**: `DOUBLE`**Provider name**: `hour`**Description**: Set the hour to start the snapshot (0-23), defaults to midnight (0).
  - `minute`**Type**: `DOUBLE`**Provider name**: `minute`**Description**: Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
  - `snapshots_to_keep`**Type**: `DOUBLE`**Provider name**: `snapshotsToKeep`**Description**: The maximum number of Snapshots to keep for the hourly schedule
- `enabled`**Type**: `BOOLEAN`**Provider name**: `enabled`**Description**: If enabled, make snapshots automatically according to the schedules. Default is false.
- `hourly_schedule`**Type**: `STRUCT`**Provider name**: `hourlySchedule`**Description**: Hourly schedule policy.
  - `minute`**Type**: `DOUBLE`**Provider name**: `minute`**Description**: Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
  - `snapshots_to_keep`**Type**: `DOUBLE`**Provider name**: `snapshotsToKeep`**Description**: The maximum number of Snapshots to keep for the hourly schedule
- `monthly_schedule`**Type**: `STRUCT`**Provider name**: `monthlySchedule`**Description**: Monthly schedule policy.
  - `days_of_month`**Type**: `STRING`**Provider name**: `daysOfMonth`**Description**: Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
  - `hour`**Type**: `DOUBLE`**Provider name**: `hour`**Description**: Set the hour to start the snapshot (0-23), defaults to midnight (0).
  - `minute`**Type**: `DOUBLE`**Provider name**: `minute`**Description**: Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
  - `snapshots_to_keep`**Type**: `DOUBLE`**Provider name**: `snapshotsToKeep`**Description**: The maximum number of Snapshots to keep for the hourly schedule
- `weekly_schedule`**Type**: `STRUCT`**Provider name**: `weeklySchedule`**Description**: Weekly schedule policy.
  - `day`**Type**: `STRING`**Provider name**: `day`**Description**: Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
  - `hour`**Type**: `DOUBLE`**Provider name**: `hour`**Description**: Set the hour to start the snapshot (0-23), defaults to midnight (0).
  - `minute`**Type**: `DOUBLE`**Provider name**: `minute`**Description**: Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
  - `snapshots_to_keep`**Type**: `DOUBLE`**Provider name**: `snapshotsToKeep`**Description**: The maximum number of Snapshots to keep for the hourly schedule

## `state`{% #state %}

**Type**: `STRING`**Provider name**: `state`**Description**: Output only. State of the volume**Possible values**:

- `STATE_UNSPECIFIED` - Unspecified Volume State
- `READY` - Volume State is Ready
- `CREATING` - Volume State is Creating
- `DELETING` - Volume State is Deleting
- `UPDATING` - Volume State is Updating
- `RESTORING` - Volume State is Restoring
- `DISABLED` - Volume State is Disabled
- `ERROR` - Volume State is Error
- `PREPARING` - Volume State is Preparing. Note that this is different from CREATING where CREATING means the volume is being created, while PREPARING means the volume is created and now being prepared for the replication.
- `READ_ONLY` - Volume State is Read Only

## `state_details`{% #state_details %}

**Type**: `STRING`**Provider name**: `stateDetails`**Description**: Output only. State details of the volume

## `storage_pool`{% #storage_pool %}

**Type**: `STRING`**Provider name**: `storagePool`**Description**: Required. StoragePool name of the volume

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `tiering_policy`{% #tiering_policy %}

**Type**: `STRUCT`**Provider name**: `tieringPolicy`**Description**: Tiering policy for the volume.

- `cooling_threshold_days`**Type**: `INT32`**Provider name**: `coolingThresholdDays`**Description**: Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31.
- `tier_action`**Type**: `STRING`**Provider name**: `tierAction`**Description**: Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.**Possible values**:
  - `TIER_ACTION_UNSPECIFIED` - Unspecified.
  - `ENABLED` - When tiering is enabled, new cold data will be tiered.
  - `PAUSED` - When paused, tiering won't be performed on new data. Existing data stays tiered until accessed.

## `unix_permissions`{% #unix_permissions %}

**Type**: `STRING`**Provider name**: `unixPermissions`**Description**: Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.

## `used_gib`{% #used_gib %}

**Type**: `INT64`**Provider name**: `usedGib`**Description**: Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.

## `zone`{% #zone %}

**Type**: `STRING`**Provider name**: `zone`**Description**: Output only. Specifies the active zone for regional volume.

## `zone_id`{% #zone_id %}

**Type**: `STRING`