Aiplatform Notebook Runtime

This table represents the aiplatform_notebook_runtime resource from Google Cloud Platform.

gcp.aiplatform_notebook_runtime

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
create_timecoretimestampOutput only. Timestamp when this NotebookRuntime was created.
data_persistent_disk_speccorejsonOutput only. The specification of persistent disk attached to the notebook runtime as data disk storage.
datadog_display_namecorestring
descriptioncorestringThe description of the NotebookRuntime.
encryption_speccorejsonOutput only. Customer-managed encryption key spec for the notebook runtime.
euc_configcorejsonOutput only. EUC configuration of the notebook runtime.
expiration_timecoretimestampOutput 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_namecorestringRequired. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.
health_statecorestringOutput only. The health state of the NotebookRuntime. Possible values: ['HEALTH_STATE_UNSPECIFIED', 'HEALTHY', 'UNHEALTHY']. Values descriptions: ['Unspecified health state.', 'NotebookRuntime is in healthy state. Applies to ACTIVE state.', 'NotebookRuntime is in unhealthy state. Applies to ACTIVE state.']
idle_shutdown_configcorejsonOutput only. The idle shutdown configuration of the notebook runtime.
is_upgradablecoreboolOutput only. Whether NotebookRuntime is upgradable.
labelscorearray<string>
machine_speccorejsonOutput only. The specification of a single machine used by the notebook runtime.
namecorestringOutput only. The resource name of the NotebookRuntime.
network_speccorejsonOutput only. Network spec of the notebook runtime.
network_tagscorearray<string>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_refcorejsonOutput only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.
notebook_runtime_typecorestringOutput only. The type of the notebook runtime. Possible values: ['NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED', 'USER_DEFINED', 'ONE_CLICK']. Values descriptions: ['Unspecified notebook runtime type, NotebookRuntimeType will default to USER_DEFINED.', 'runtime or template with coustomized configurations from user.', 'runtime or template with system defined configurations.']
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
proxy_uricorestringOutput only. The proxy endpoint used to access the NotebookRuntime.
reservation_affinitycorejsonOutput only. Reservation Affinity of the notebook runtime.
resource_namecorestring
runtime_statecorestringOutput only. The runtime (instance) state of the NotebookRuntime. Possible values: ['RUNTIME_STATE_UNSPECIFIED', 'RUNNING', 'BEING_STARTED', 'BEING_STOPPED', 'STOPPED', 'BEING_UPGRADED', 'ERROR', 'INVALID']. Values descriptions: ['Unspecified runtime state.', 'NotebookRuntime is in running state.', 'NotebookRuntime is in starting state.', 'NotebookRuntime is in stopping state.', 'NotebookRuntime is in stopped state.', 'NotebookRuntime is in upgrading state. It is in the middle of upgrading process.', 'NotebookRuntime was unable to start/stop properly.', 'NotebookRuntime is in invalid state. Cannot be recovered.']
runtime_usercorestringRequired. The user email of the NotebookRuntime.
satisfies_pzicoreboolOutput only. Reserved for future use.
satisfies_pzscoreboolOutput only. Reserved for future use.
service_accountcorestringOutput 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) is used for the runtime workload identity. See 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_configcorejsonOutput only. Runtime Shielded VM spec.
software_configcorejsonOutput only. Software config of the notebook runtime.
tagscorehstore
update_timecoretimestampOutput only. Timestamp when this NotebookRuntime was most recently updated.
versioncorestringOutput only. The VM os image version of NotebookRuntime.