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

# gcp_notebooks_instance{% #gcp_notebooks_instance %}

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `create_time`{% #create_time %}

**Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Output only. Instance creation time.

## `creator`{% #creator %}

**Type**: `STRING`**Provider name**: `creator`**Description**: Output only. Email address of entity that sent original CreateInstance request.

## `disable_proxy_access`{% #disable_proxy_access %}

**Type**: `BOOLEAN`**Provider name**: `disableProxyAccess`**Description**: Optional. If true, the notebook instance will not register with the proxy.

## `enable_deletion_protection`{% #enable_deletion_protection %}

**Type**: `BOOLEAN`**Provider name**: `enableDeletionProtection`**Description**: Optional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance.

## `enable_managed_euc`{% #enable_managed_euc %}

**Type**: `BOOLEAN`**Provider name**: `enableManagedEuc`**Description**: Optional. Flag to enable managed end user credentials for the instance.

## `enable_third_party_identity`{% #enable_third_party_identity %}

**Type**: `BOOLEAN`**Provider name**: `enableThirdPartyIdentity`**Description**: Optional. Flag that specifies that a notebook can be accessed with third party identity provider.

## `gce_setup`{% #gce_setup %}

**Type**: `STRUCT`**Provider name**: `gceSetup`**Description**: Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.

- `accelerator_configs`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `acceleratorConfigs`**Description**: Optional. The hardware accelerators used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](https://cloud.google.com/compute/docs/gpus/#gpus-list). Currently supports only one accelerator configuration.
  - `core_count`**Type**: `INT64`**Provider name**: `coreCount`**Description**: Optional. Count of cores of this accelerator.
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: Optional. Type of this accelerator.**Possible values**:
    - `ACCELERATOR_TYPE_UNSPECIFIED` - Accelerator type is not specified.
    - `NVIDIA_TESLA_P100` - Accelerator type is Nvidia Tesla P100.
    - `NVIDIA_TESLA_V100` - Accelerator type is Nvidia Tesla V100.
    - `NVIDIA_TESLA_P4` - Accelerator type is Nvidia Tesla P4.
    - `NVIDIA_TESLA_T4` - Accelerator type is Nvidia Tesla T4.
    - `NVIDIA_TESLA_A100` - Accelerator type is Nvidia Tesla A100 - 40GB.
    - `NVIDIA_A100_80GB` - Accelerator type is Nvidia Tesla A100 - 80GB.
    - `NVIDIA_L4` - Accelerator type is Nvidia Tesla L4.
    - `NVIDIA_H100_80GB` - Accelerator type is Nvidia Tesla H100 - 80GB.
    - `NVIDIA_H100_MEGA_80GB` - Accelerator type is Nvidia Tesla H100 - MEGA 80GB.
    - `NVIDIA_TESLA_T4_VWS` - Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    - `NVIDIA_TESLA_P100_VWS` - Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    - `NVIDIA_TESLA_P4_VWS` - Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
- `boot_disk`**Type**: `STRUCT`**Provider name**: `bootDisk`**Description**: Optional. The boot disk for the VM.
  - `disk_encryption`**Type**: `STRING`**Provider name**: `diskEncryption`**Description**: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.**Possible values**:
    - `DISK_ENCRYPTION_UNSPECIFIED` - Disk encryption is not specified.
    - `GMEK` - Use Google managed encryption keys to encrypt the boot disk.
    - `CMEK` - Use customer managed encryption keys to encrypt the boot disk.
  - `disk_size_gb`**Type**: `INT64`**Provider name**: `diskSizeGb`**Description**: Optional. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to the recommended value of 150GB.
  - `disk_type`**Type**: `STRING`**Provider name**: `diskType`**Description**: Optional. Indicates the type of the disk.**Possible values**:
    - `DISK_TYPE_UNSPECIFIED` - Disk type not set.
    - `PD_STANDARD` - Standard persistent disk type.
    - `PD_SSD` - SSD persistent disk type.
    - `PD_BALANCED` - Balanced persistent disk type.
    - `PD_EXTREME` - Extreme persistent disk type.
  - `kms_key`**Type**: `STRING`**Provider name**: `kmsKey`**Description**: Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys.
- `confidential_instance_config`**Type**: `STRUCT`**Provider name**: `confidentialInstanceConfig`**Description**: Optional. Confidential instance configuration.
  - `confidential_instance_type`**Type**: `STRING`**Provider name**: `confidentialInstanceType`**Description**: Optional. Defines the type of technology used by the confidential instance.**Possible values**:
    - `CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED` - No type specified. Do not use this value.
    - `SEV` - AMD Secure Encrypted Virtualization.
- `container_image`**Type**: `STRUCT`**Provider name**: `containerImage`**Description**: Optional. Use a container image to start the notebook instance.
  - `repository`**Type**: `STRING`**Provider name**: `repository`**Description**: Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
  - `tag`**Type**: `STRING`**Provider name**: `tag`**Description**: Optional. The tag of the container image. If not specified, this defaults to the latest tag.
- `data_disks`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `dataDisks`**Description**: Optional. Data disks attached to the VM instance. Currently supports only one data disk.
  - `disk_encryption`**Type**: `STRING`**Provider name**: `diskEncryption`**Description**: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.**Possible values**:
    - `DISK_ENCRYPTION_UNSPECIFIED` - Disk encryption is not specified.
    - `GMEK` - Use Google managed encryption keys to encrypt the boot disk.
    - `CMEK` - Use customer managed encryption keys to encrypt the boot disk.
  - `disk_size_gb`**Type**: `INT64`**Provider name**: `diskSizeGb`**Description**: Optional. The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to 100.
  - `disk_type`**Type**: `STRING`**Provider name**: `diskType`**Description**: Optional. Input only. Indicates the type of the disk.**Possible values**:
    - `DISK_TYPE_UNSPECIFIED` - Disk type not set.
    - `PD_STANDARD` - Standard persistent disk type.
    - `PD_SSD` - SSD persistent disk type.
    - `PD_BALANCED` - Balanced persistent disk type.
    - `PD_EXTREME` - Extreme persistent disk type.
  - `kms_key`**Type**: `STRING`**Provider name**: `kmsKey`**Description**: Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys.
- `disable_public_ip`**Type**: `BOOLEAN`**Provider name**: `disablePublicIp`**Description**: Optional. If true, no external IP will be assigned to this VM instance.
- `enable_ip_forwarding`**Type**: `BOOLEAN`**Provider name**: `enableIpForwarding`**Description**: Optional. Flag to enable ip forwarding or not, default false/off. [https://cloud.google.com/vpc/docs/using-routes#canipforward](https://cloud.google.com/vpc/docs/using-routes#canipforward)
- `gpu_driver_config`**Type**: `STRUCT`**Provider name**: `gpuDriverConfig`**Description**: Optional. Configuration for GPU drivers.
  - `custom_gpu_driver_path`**Type**: `STRING`**Provider name**: `customGpuDriverPath`**Description**: Optional. Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
  - `enable_gpu_driver`**Type**: `BOOLEAN`**Provider name**: `enableGpuDriver`**Description**: Optional. Whether the end user authorizes Google Cloud to install GPU driver on this VM instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
- `machine_type`**Type**: `STRING`**Provider name**: `machineType`**Description**: Optional. The machine type of the VM instance. [https://cloud.google.com/compute/docs/machine-resource](https://cloud.google.com/compute/docs/machine-resource)
- `min_cpu_platform`**Type**: `STRING`**Provider name**: `minCpuPlatform`**Description**: Optional. The minimum CPU platform to use for this instance. The list of valid values can be found in [https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones)
- `network_interfaces`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `networkInterfaces`**Description**: Optional. The network interfaces for the VM. Supports only one interface.
  - `access_configs`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `accessConfigs`**Description**: Optional. An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If no accessConfigs specified, the instance will have an external internet access through an ephemeral external IP address.
    - `external_ip`**Type**: `STRING`**Provider name**: `externalIp`**Description**: An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
  - `network`**Type**: `STRING`**Provider name**: `network`**Description**: Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}`
  - `nic_type`**Type**: `STRING`**Provider name**: `nicType`**Description**: Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.**Possible values**:
    - `NIC_TYPE_UNSPECIFIED` - No type specified.
    - `VIRTIO_NET` - VIRTIO
    - `GVNIC` - GVNIC
  - `subnet`**Type**: `STRING`**Provider name**: `subnet`**Description**: Optional. The name of the subnet that this VM instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
- `reservation_affinity`**Type**: `STRUCT`**Provider name**: `reservationAffinity`**Description**: Optional. Specifies the reservations that this instance can consume from.
  - `consume_reservation_type`**Type**: `STRING`**Provider name**: `consumeReservationType`**Description**: Required. Specifies the type of reservation from which this instance can consume resources: RESERVATION_ANY (default), RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved instances for examples.**Possible values**:
    - `RESERVATION_UNSPECIFIED` - Default type.
    - `RESERVATION_NONE` - Do not consume from any allocated capacity.
    - `RESERVATION_ANY` - Consume any reservation available.
    - `RESERVATION_SPECIFIC` - Must consume from a specific reservation. Must specify key value fields for specifying the reservations.
  - `key`**Type**: `STRING`**Provider name**: `key`**Description**: Optional. Corresponds to the label key of a reservation resource. To target a RESERVATION_SPECIFIC by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
  - `values`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `values`**Description**: Optional. Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.
- `service_accounts`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `serviceAccounts`**Description**: Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.
  - `email`**Type**: `STRING`**Provider name**: `email`**Description**: Optional. Email address of the service account.
  - `scopes`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `scopes`**Description**: Output only. The list of scopes to be made available for this service account. Set by the CLH to [https://www.googleapis.com/auth/cloud-platform](https://www.googleapis.com/auth/cloud-platform)
- `shielded_instance_config`**Type**: `STRUCT`**Provider name**: `shieldedInstanceConfig`**Description**: Optional. Shielded VM configuration. [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
  - `enable_integrity_monitoring`**Type**: `BOOLEAN`**Provider name**: `enableIntegrityMonitoring`**Description**: Optional. Defines whether the VM instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the VM instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the VM instance is created.
  - `enable_secure_boot`**Type**: `BOOLEAN`**Provider name**: `enableSecureBoot`**Description**: Optional. Defines whether the VM instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.
  - `enable_vtpm`**Type**: `BOOLEAN`**Provider name**: `enableVtpm`**Description**: Optional. Defines whether the VM instance has the vTPM enabled.
- `vm_image`**Type**: `STRUCT`**Provider name**: `vmImage`**Description**: Optional. Use a Compute Engine VM image to start the notebook instance.
  - `family`**Type**: `STRING`**Provider name**: `family`**Description**: Optional. Use this VM image family to find the image; the newest image in this family will be used.
  - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Optional. Use VM image name to find the image.
  - `project`**Type**: `STRING`**Provider name**: `project`**Description**: Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`

## `health_state`{% #health_state %}

**Type**: `STRING`**Provider name**: `healthState`**Description**: Output only. Instance health_state.**Possible values**:

- `HEALTH_STATE_UNSPECIFIED` - The instance substate is unknown.
- `HEALTHY` - The instance is known to be in an healthy state (for example, critical daemons are running) Applies to ACTIVE state.
- `UNHEALTHY` - The instance is known to be in an unhealthy state (for example, critical daemons are not running) Applies to ACTIVE state.
- `AGENT_NOT_INSTALLED` - The instance has not installed health monitoring agent. Applies to ACTIVE state.
- `AGENT_NOT_RUNNING` - The instance health monitoring agent is not running. Applies to ACTIVE state.

## `id`{% #id %}

**Type**: `STRING`**Provider name**: `id`**Description**: Output only. Unique ID of the resource.

## `instance_owners`{% #instance_owners %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `instanceOwners`**Description**: Optional. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `proxy_uri`{% #proxy_uri %}

**Type**: `STRING`**Provider name**: `proxyUri`**Description**: Output only. The proxy endpoint that is used to access the Jupyter notebook.

## `region_id`{% #region_id %}

**Type**: `STRING`

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `satisfies_pzi`{% #satisfies_pzi %}

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

## `satisfies_pzs`{% #satisfies_pzs %}

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

## `state`{% #state %}

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

- `STATE_UNSPECIFIED` - State is not specified.
- `STARTING` - The control logic is starting the instance.
- `PROVISIONING` - The control logic is installing required frameworks and registering the instance with notebook proxy
- `ACTIVE` - The instance is running.
- `STOPPING` - The control logic is stopping the instance.
- `STOPPED` - The instance is stopped.
- `DELETED` - The instance is deleted.
- `UPGRADING` - The instance is upgrading.
- `INITIALIZING` - The instance is being created.
- `SUSPENDING` - The instance is suspending.
- `SUSPENDED` - The instance is suspended.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `third_party_proxy_url`{% #third_party_proxy_url %}

**Type**: `STRING`**Provider name**: `thirdPartyProxyUrl`**Description**: Output only. The workforce pools proxy endpoint that is used to access the Jupyter notebook.

## `update_time`{% #update_time %}

**Type**: `TIMESTAMP`**Provider name**: `updateTime`**Description**: Output only. Instance update time.

## `upgrade_history`{% #upgrade_history %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `upgradeHistory`**Description**: Output only. The upgrade history of this instance.

- `action`**Type**: `STRING`**Provider name**: `action`**Description**: Optional. Action. Rolloback or Upgrade.**Possible values**:
  - `ACTION_UNSPECIFIED` - Operation is not specified.
  - `UPGRADE` - Upgrade.
  - `ROLLBACK` - Rollback.
- `container_image`**Type**: `STRING`**Provider name**: `containerImage`**Description**: Optional. The container image before this instance upgrade.
- `create_time`**Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Immutable. The time that this instance upgrade history entry is created.
- `framework`**Type**: `STRING`**Provider name**: `framework`**Description**: Optional. The framework of this notebook instance.
- `snapshot`**Type**: `STRING`**Provider name**: `snapshot`**Description**: Optional. The snapshot of the boot disk of this notebook instance before upgrade.
- `state`**Type**: `STRING`**Provider name**: `state`**Description**: Output only. The state of this instance upgrade history entry.**Possible values**:
  - `STATE_UNSPECIFIED` - State is not specified.
  - `STARTED` - The instance upgrade is started.
  - `SUCCEEDED` - The instance upgrade is succeeded.
  - `FAILED` - The instance upgrade is failed.
- `target_version`**Type**: `STRING`**Provider name**: `targetVersion`**Description**: Optional. Target VM Version, like m63.
- `version`**Type**: `STRING`**Provider name**: `version`**Description**: Optional. The version of the notebook instance before this upgrade.
- `vm_image`**Type**: `STRING`**Provider name**: `vmImage`**Description**: Optional. The VM image before this instance upgrade.

## `zone_id`{% #zone_id %}

**Type**: `STRING`