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

# gcp_aiplatform_notebook_runtime{% #gcp_aiplatform_notebook_runtime %}

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `create_time`{% #create_time %}

**Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Output only. Timestamp when this NotebookRuntime was created.

## `data_persistent_disk_spec`{% #data_persistent_disk_spec %}

**Type**: `STRUCT`**Provider name**: `dataPersistentDiskSpec`**Description**: Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.

- `disk_size_gb`**Type**: `INT64`**Provider name**: `diskSizeGb`**Description**: Size in GB of the disk (default is 100GB).
- `disk_type`**Type**: `STRING`**Provider name**: `diskType`**Description**: Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)

## `description`{% #description %}

**Type**: `STRING`**Provider name**: `description`**Description**: The description of the NotebookRuntime.

## `encryption_spec`{% #encryption_spec %}

**Type**: `STRUCT`**Provider name**: `encryptionSpec`**Description**: Output only. Customer-managed encryption key spec for the notebook runtime.

- `kms_key_name`**Type**: `STRING`**Provider name**: `kmsKeyName`**Description**: Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.

## `euc_config`{% #euc_config %}

**Type**: `STRUCT`**Provider name**: `eucConfig`**Description**: Output only. EUC configuration of the notebook runtime.

- `bypass_actas_check`**Type**: `BOOLEAN`**Provider name**: `bypassActasCheck`**Description**: Output only. Whether ActAs check is bypassed for service account attached to the VM. If false, we need ActAs check for the default Compute Engine Service account. When a Runtime is created, a VM is allocated using Default Compute Engine Service Account. Any user requesting to use this Runtime requires Service Account User (ActAs) permission over this SA. If true, Runtime owner is using EUC and does not require the above permission as VM no longer use default Compute Engine SA, but a P4SA.
- `euc_disabled`**Type**: `BOOLEAN`**Provider name**: `eucDisabled`**Description**: Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. In proto3, the default value of a boolean is false. In this way, by default EUC will be enabled for NotebookRuntimeTemplate.

## `expiration_time`{% #expiration_time %}

**Type**: `TIMESTAMP`**Provider name**: `expirationTime`**Description**: Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.

## `gcp_display_name`{% #gcp_display_name %}

**Type**: `STRING`**Provider name**: `displayName`**Description**: Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.

## `health_state`{% #health_state %}

**Type**: `STRING`**Provider name**: `healthState`**Description**: Output only. The health state of the NotebookRuntime.**Possible values**:

- `HEALTH_STATE_UNSPECIFIED` - Unspecified health state.
- `HEALTHY` - NotebookRuntime is in healthy state. Applies to ACTIVE state.
- `UNHEALTHY` - NotebookRuntime is in unhealthy state. Applies to ACTIVE state.

## `idle_shutdown_config`{% #idle_shutdown_config %}

**Type**: `STRUCT`**Provider name**: `idleShutdownConfig`**Description**: Output only. The idle shutdown configuration of the notebook runtime.

- `idle_shutdown_disabled`**Type**: `BOOLEAN`**Provider name**: `idleShutdownDisabled`**Description**: Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
- `idle_timeout`**Type**: `STRING`**Provider name**: `idleTimeout`**Description**: Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60.

## `is_upgradable`{% #is_upgradable %}

**Type**: `BOOLEAN`**Provider name**: `isUpgradable`**Description**: Output only. Whether NotebookRuntime is upgradable.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `machine_spec`{% #machine_spec %}

**Type**: `STRUCT`**Provider name**: `machineSpec`**Description**: Output only. The specification of a single machine used by the notebook runtime.

- `accelerator_count`**Type**: `INT32`**Provider name**: `acceleratorCount`**Description**: The number of accelerators to attach to the machine.
- `accelerator_type`**Type**: `STRING`**Provider name**: `acceleratorType`**Description**: Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.**Possible values**:
  - `ACCELERATOR_TYPE_UNSPECIFIED` - Unspecified accelerator type, which means no accelerator.
  - `NVIDIA_TESLA_K80` - Deprecated: Nvidia Tesla K80 GPU has reached end of support, see [https://cloud.google.com/compute/docs/eol/k80-eol](https://cloud.google.com/compute/docs/eol/k80-eol).
  - `NVIDIA_TESLA_P100` - Nvidia Tesla P100 GPU.
  - `NVIDIA_TESLA_V100` - Nvidia Tesla V100 GPU.
  - `NVIDIA_TESLA_P4` - Nvidia Tesla P4 GPU.
  - `NVIDIA_TESLA_T4` - Nvidia Tesla T4 GPU.
  - `NVIDIA_TESLA_A100` - Nvidia Tesla A100 GPU.
  - `NVIDIA_A100_80GB` - Nvidia A100 80GB GPU.
  - `NVIDIA_L4` - Nvidia L4 GPU.
  - `NVIDIA_H100_80GB` - Nvidia H100 80Gb GPU.
  - `NVIDIA_H100_MEGA_80GB` - Nvidia H100 Mega 80Gb GPU.
  - `NVIDIA_H200_141GB` - Nvidia H200 141Gb GPU.
  - `TPU_V2` - TPU v2.
  - `TPU_V3` - TPU v3.
  - `TPU_V4_POD` - TPU v4.
  - `TPU_V5_LITEPOD` - TPU v5.
- `machine_type`**Type**: `STRING`**Provider name**: `machineType`**Description**: Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
- `reservation_affinity`**Type**: `STRUCT`**Provider name**: `reservationAffinity`**Description**: Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
  - `key`**Type**: `STRING`**Provider name**: `key`**Description**: Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
  - `reservation_affinity_type`**Type**: `STRING`**Provider name**: `reservationAffinityType`**Description**: Required. Specifies the reservation affinity type.**Possible values**:
    - `TYPE_UNSPECIFIED` - Default value. This should not be used.
    - `NO_RESERVATION` - Do not consume from any reserved capacity, only use on-demand.
    - `ANY_RESERVATION` - Consume any reservation available, falling back to on-demand.
    - `SPECIFIC_RESERVATION` - Consume from a specific reservation. When chosen, the reservation must be identified via the `key` and `values` fields.
  - `values`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `values`**Description**: Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
- `tpu_topology`**Type**: `STRING`**Provider name**: `tpuTopology`**Description**: Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Output only. The resource name of the NotebookRuntime.

## `network_spec`{% #network_spec %}

**Type**: `STRUCT`**Provider name**: `networkSpec`**Description**: Output only. Network spec of the notebook runtime.

- `enable_internet_access`**Type**: `BOOLEAN`**Provider name**: `enableInternetAccess`**Description**: Whether to enable public internet access. Default false.
- `network`**Type**: `STRING`**Provider name**: `network`**Description**: The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
- `subnetwork`**Type**: `STRING`**Provider name**: `subnetwork`**Description**: The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`

## `network_tags`{% #network_tags %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `networkTags`**Description**: Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).

## `notebook_runtime_template_ref`{% #notebook_runtime_template_ref %}

**Type**: `STRUCT`**Provider name**: `notebookRuntimeTemplateRef`**Description**: Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.

- `notebook_runtime_template`**Type**: `STRING`**Provider name**: `notebookRuntimeTemplate`**Description**: Immutable. A resource name of the NotebookRuntimeTemplate.

## `notebook_runtime_type`{% #notebook_runtime_type %}

**Type**: `STRING`**Provider name**: `notebookRuntimeType`**Description**: Output only. The type of the notebook runtime.**Possible values**:

- `NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED` - Unspecified notebook runtime type, NotebookRuntimeType will default to USER_DEFINED.
- `USER_DEFINED` - runtime or template with coustomized configurations from user.
- `ONE_CLICK` - runtime or template with system defined configurations.

## `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 used to access the NotebookRuntime.

## `region_id`{% #region_id %}

**Type**: `STRING`

## `reservation_affinity`{% #reservation_affinity %}

**Type**: `STRUCT`**Provider name**: `reservationAffinity`**Description**: Output only. Reservation Affinity of the notebook runtime.

- `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_AFFINITY_TYPE_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 must be the full path name of Reservation.

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `runtime_state`{% #runtime_state %}

**Type**: `STRING`**Provider name**: `runtimeState`**Description**: Output only. The runtime (instance) state of the NotebookRuntime.**Possible values**:

- `RUNTIME_STATE_UNSPECIFIED` - Unspecified runtime state.
- `RUNNING` - NotebookRuntime is in running state.
- `BEING_STARTED` - NotebookRuntime is in starting state.
- `BEING_STOPPED` - NotebookRuntime is in stopping state.
- `STOPPED` - NotebookRuntime is in stopped state.
- `BEING_UPGRADED` - NotebookRuntime is in upgrading state. It is in the middle of upgrading process.
- `ERROR` - NotebookRuntime was unable to start/stop properly.
- `INVALID` - NotebookRuntime is in invalid state. Cannot be recovered.

## `runtime_user`{% #runtime_user %}

**Type**: `STRING`**Provider name**: `runtimeUser`**Description**: Required. The user email of the NotebookRuntime.

## `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.

## `service_account`{% #service_account %}

**Type**: `STRING`**Provider name**: `serviceAccount`**Description**: Output only. Deprecated: This field is no longer used and the "Vertex AI Notebook Service Account" ([service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com](mailto:service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com)) is used for the runtime workload identity. See [https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account](https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account) for more details. The service account that the NotebookRuntime workload runs as.

## `shielded_vm_config`{% #shielded_vm_config %}

**Type**: `STRUCT`**Provider name**: `shieldedVmConfig`**Description**: Output only. Runtime Shielded VM spec.

- `enable_secure_boot`**Type**: `BOOLEAN`**Provider name**: `enableSecureBoot`**Description**: Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#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.

## `software_config`{% #software_config %}

**Type**: `STRUCT`**Provider name**: `softwareConfig`**Description**: Output only. Software config of the notebook runtime.

- `env`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `env`**Description**: Optional. Environment variables to be passed to the container. Maximum limit is 100.
  - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Required. Name of the environment variable. Must be a valid C identifier.
  - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
- `post_startup_script_config`**Type**: `STRUCT`**Provider name**: `postStartupScriptConfig`**Description**: Optional. Post startup script config.
  - `post_startup_script`**Type**: `STRING`**Provider name**: `postStartupScript`**Description**: Optional. Post startup script to run after runtime is started.
  - `post_startup_script_behavior`**Type**: `STRING`**Provider name**: `postStartupScriptBehavior`**Description**: Optional. Post startup script behavior that defines download and execution behavior.**Possible values**:
    - `POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED` - Unspecified post startup script behavior.
    - `RUN_ONCE` - Run post startup script after runtime is started.
    - `RUN_EVERY_START` - Run post startup script after runtime is stopped.
    - `DOWNLOAD_AND_RUN_EVERY_START` - Download and run post startup script every time runtime is started.
  - `post_startup_script_url`**Type**: `STRING`**Provider name**: `postStartupScriptUrl`**Description**: Optional. Post startup script url to download. Example: `gs://bucket/script.sh`

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `update_time`{% #update_time %}

**Type**: `TIMESTAMP`**Provider name**: `updateTime`**Description**: Output only. Timestamp when this NotebookRuntime was most recently updated.

## `version`{% #version %}

**Type**: `STRING`**Provider name**: `version`**Description**: Output only. The VM os image version of NotebookRuntime.

## `zone_id`{% #zone_id %}

**Type**: `STRING`