Google Cloud Native v0.32.0, Nov 29 23

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.notebooks/v2.getInstance

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

Using getInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>

def get_instance(instance_id: Optional[str] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                 location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]

func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

> Note: This function is named LookupInstance in the Go SDK.

public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:notebooks/v2:getInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string
Location string
Project string

InstanceId string
Location string
Project string

instanceId String
location String
project String

instanceId string
location string
project string

instance_id str
location str
project str

instanceId String
location String
project String

getInstance Result

The following output properties are available:

CreateTime string: Instance creation time.
Creator string: Email address of entity that sent original CreateInstance request.
DisableProxyAccess bool: Optional. If true, the notebook instance will not register with the proxy.
GceSetup Pulumi.GoogleNative.Notebooks.V2.Outputs.GceSetupResponse: Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
HealthInfo Dictionary<string, string>: Additional information about instance health. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }
HealthState string: Instance health_state.
InstanceOwners List<string>: Optional. Input only. 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 Dictionary<string, string>: Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
Name string: The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
ProxyUri string: The proxy endpoint that is used to access the Jupyter notebook.
State string: The state of this instance.
UpdateTime string: Instance update time.
UpgradeHistory List<Pulumi.GoogleNative.Notebooks.V2.Outputs.UpgradeHistoryEntryResponse>: The upgrade history of this instance.

CreateTime string: Instance creation time.
Creator string: Email address of entity that sent original CreateInstance request.
DisableProxyAccess bool: Optional. If true, the notebook instance will not register with the proxy.
GceSetup GceSetupResponse: Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
HealthInfo map[string]string: Additional information about instance health. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }
HealthState string: Instance health_state.
InstanceOwners []string: Optional. Input only. 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 map[string]string: Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
Name string: The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
ProxyUri string: The proxy endpoint that is used to access the Jupyter notebook.
State string: The state of this instance.
UpdateTime string: Instance update time.
UpgradeHistory []UpgradeHistoryEntryResponse: The upgrade history of this instance.

createTime String: Instance creation time.
creator String: Email address of entity that sent original CreateInstance request.
disableProxyAccess Boolean: Optional. If true, the notebook instance will not register with the proxy.
gceSetup GceSetupResponse: Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
healthInfo Map<String,String>: Additional information about instance health. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }
healthState String: Instance health_state.
instanceOwners List<String>: Optional. Input only. 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 Map<String,String>: Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
name String: The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
proxyUri String: The proxy endpoint that is used to access the Jupyter notebook.
state String: The state of this instance.
updateTime String: Instance update time.
upgradeHistory List<UpgradeHistoryEntryResponse>: The upgrade history of this instance.

createTime string: Instance creation time.
creator string: Email address of entity that sent original CreateInstance request.
disableProxyAccess boolean: Optional. If true, the notebook instance will not register with the proxy.
gceSetup GceSetupResponse: Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
healthInfo {[key: string]: string}: Additional information about instance health. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }
healthState string: Instance health_state.
instanceOwners string[]: Optional. Input only. 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 {[key: string]: string}: Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
name string: The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
proxyUri string: The proxy endpoint that is used to access the Jupyter notebook.
state string: The state of this instance.
updateTime string: Instance update time.
upgradeHistory UpgradeHistoryEntryResponse[]: The upgrade history of this instance.

create_time str: Instance creation time.
creator str: Email address of entity that sent original CreateInstance request.
disable_proxy_access bool: Optional. If true, the notebook instance will not register with the proxy.
gce_setup GceSetupResponse: Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
health_info Mapping[str, str]: Additional information about instance health. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }
health_state str: Instance health_state.
instance_owners Sequence[str]: Optional. Input only. 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 Mapping[str, str]: Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
name str: The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
proxy_uri str: The proxy endpoint that is used to access the Jupyter notebook.
state str: The state of this instance.
update_time str: Instance update time.
upgrade_history Sequence[UpgradeHistoryEntryResponse]: The upgrade history of this instance.

createTime String: Instance creation time.
creator String: Email address of entity that sent original CreateInstance request.
disableProxyAccess Boolean: Optional. If true, the notebook instance will not register with the proxy.
gceSetup Property Map: Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
healthInfo Map<String>: Additional information about instance health. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }
healthState String: Instance health_state.
instanceOwners List<String>: Optional. Input only. 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 Map<String>: Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
name String: The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
proxyUri String: The proxy endpoint that is used to access the Jupyter notebook.
state String: The state of this instance.
updateTime String: Instance update time.
upgradeHistory List<Property Map>: The upgrade history of this instance.

Supporting Types

AcceleratorConfigResponse

CoreCount string: Optional. Count of cores of this accelerator.
Type string: Optional. Type of this accelerator.

CoreCount string: Optional. Count of cores of this accelerator.
Type string: Optional. Type of this accelerator.

coreCount String: Optional. Count of cores of this accelerator.
type String: Optional. Type of this accelerator.

coreCount string: Optional. Count of cores of this accelerator.
type string: Optional. Type of this accelerator.

core_count str: Optional. Count of cores of this accelerator.
type str: Optional. Type of this accelerator.

coreCount String: Optional. Count of cores of this accelerator.
type String: Optional. Type of this accelerator.

BootDiskResponse

DiskEncryption string: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
DiskSizeGb string: 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.
DiskType string: Optional. Indicates the type of the disk.
KmsKey string: 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.

DiskEncryption string: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
DiskSizeGb string: 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.
DiskType string: Optional. Indicates the type of the disk.
KmsKey string: 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.

diskEncryption String: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
diskSizeGb String: 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.
diskType String: Optional. Indicates the type of the disk.
kmsKey String: 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.

diskEncryption string: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
diskSizeGb string: 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.
diskType string: Optional. Indicates the type of the disk.
kmsKey string: 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.

disk_encryption str: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
disk_size_gb str: 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 str: Optional. Indicates the type of the disk.
kms_key str: 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.

diskEncryption String: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
diskSizeGb String: 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.
diskType String: Optional. Indicates the type of the disk.
kmsKey String: 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.

ContainerImageResponse

Repository string: The path to the container image repository. For example: gcr.io/{project_id}/{image_name}
Tag string: Optional. The tag of the container image. If not specified, this defaults to the latest tag.

Repository string: The path to the container image repository. For example: gcr.io/{project_id}/{image_name}
Tag string: Optional. The tag of the container image. If not specified, this defaults to the latest tag.

repository String: The path to the container image repository. For example: gcr.io/{project_id}/{image_name}
tag String: Optional. The tag of the container image. If not specified, this defaults to the latest tag.

repository string: The path to the container image repository. For example: gcr.io/{project_id}/{image_name}
tag string: Optional. The tag of the container image. If not specified, this defaults to the latest tag.

repository str: The path to the container image repository. For example: gcr.io/{project_id}/{image_name}
tag str: Optional. The tag of the container image. If not specified, this defaults to the latest tag.

repository String: The path to the container image repository. For example: gcr.io/{project_id}/{image_name}
tag String: Optional. The tag of the container image. If not specified, this defaults to the latest tag.

DataDiskResponse

DiskEncryption string: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
DiskSizeGb string: 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.
DiskType string: Optional. Input only. Indicates the type of the disk.
KmsKey string: 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.

DiskEncryption string: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
DiskSizeGb string: 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.
DiskType string: Optional. Input only. Indicates the type of the disk.
KmsKey string: 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.

diskEncryption String: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
diskSizeGb String: 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.
diskType String: Optional. Input only. Indicates the type of the disk.
kmsKey String: 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.

diskEncryption string: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
diskSizeGb string: 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.
diskType string: Optional. Input only. Indicates the type of the disk.
kmsKey string: 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.

disk_encryption str: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
disk_size_gb str: 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 str: Optional. Input only. Indicates the type of the disk.
kms_key str: 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.

diskEncryption String: Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
diskSizeGb String: 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.
diskType String: Optional. Input only. Indicates the type of the disk.
kmsKey String: 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.

GPUDriverConfigResponse

CustomGpuDriverPath string: Optional. Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
EnableGpuDriver bool: 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.

CustomGpuDriverPath string: Optional. Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
EnableGpuDriver bool: 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.

customGpuDriverPath String: Optional. Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
enableGpuDriver Boolean: 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.

customGpuDriverPath string: Optional. Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
enableGpuDriver boolean: 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.

custom_gpu_driver_path str: 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 bool: 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.

customGpuDriverPath String: Optional. Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
enableGpuDriver Boolean: 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.

GceSetupResponse

AcceleratorConfigs List<Pulumi.GoogleNative.Notebooks.V2.Inputs.AcceleratorConfigResponse>: 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. Currently supports only one accelerator configuration.
BootDisk Pulumi.GoogleNative.Notebooks.V2.Inputs.BootDiskResponse: Optional. The boot disk for the VM.
ContainerImage Pulumi.GoogleNative.Notebooks.V2.Inputs.ContainerImageResponse: Optional. Use a container image to start the notebook instance.
DataDisks List<Pulumi.GoogleNative.Notebooks.V2.Inputs.DataDiskResponse>: Optional. Data disks attached to the VM instance. Currently supports only one data disk.
DisablePublicIp bool: Optional. If true, no external IP will be assigned to this VM instance.
EnableIpForwarding bool: Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
GpuDriverConfig Pulumi.GoogleNative.Notebooks.V2.Inputs.GPUDriverConfigResponse: Optional. Configuration for GPU drivers.
MachineType string: Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource
Metadata Dictionary<string, string>: Optional. Custom metadata to apply to this instance.
NetworkInterfaces List<Pulumi.GoogleNative.Notebooks.V2.Inputs.NetworkInterfaceResponse>: Optional. The network interfaces for the VM. Supports only one interface.
ServiceAccounts List<Pulumi.GoogleNative.Notebooks.V2.Inputs.ServiceAccountResponse>: Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.
ShieldedInstanceConfig Pulumi.GoogleNative.Notebooks.V2.Inputs.ShieldedInstanceConfigResponse: Optional. Shielded VM configuration. Images using supported Shielded VM features.
Tags List<string>: Optional. The Compute Engine tags to add to runtime (see Tagging instances).
VmImage Pulumi.GoogleNative.Notebooks.V2.Inputs.VmImageResponse: Optional. Use a Compute Engine VM image to start the notebook instance.

AcceleratorConfigs []AcceleratorConfigResponse: 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. Currently supports only one accelerator configuration.
BootDisk BootDiskResponse: Optional. The boot disk for the VM.
ContainerImage ContainerImageResponse: Optional. Use a container image to start the notebook instance.
DataDisks []DataDiskResponse: Optional. Data disks attached to the VM instance. Currently supports only one data disk.
DisablePublicIp bool: Optional. If true, no external IP will be assigned to this VM instance.
EnableIpForwarding bool: Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
GpuDriverConfig GPUDriverConfigResponse: Optional. Configuration for GPU drivers.
MachineType string: Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource
Metadata map[string]string: Optional. Custom metadata to apply to this instance.
NetworkInterfaces []NetworkInterfaceResponse: Optional. The network interfaces for the VM. Supports only one interface.
ServiceAccounts []ServiceAccountResponse: Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.
ShieldedInstanceConfig ShieldedInstanceConfigResponse: Optional. Shielded VM configuration. Images using supported Shielded VM features.
Tags []string: Optional. The Compute Engine tags to add to runtime (see Tagging instances).
VmImage VmImageResponse: Optional. Use a Compute Engine VM image to start the notebook instance.

acceleratorConfigs List<AcceleratorConfigResponse>: 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. Currently supports only one accelerator configuration.
bootDisk BootDiskResponse: Optional. The boot disk for the VM.
containerImage ContainerImageResponse: Optional. Use a container image to start the notebook instance.
dataDisks List<DataDiskResponse>: Optional. Data disks attached to the VM instance. Currently supports only one data disk.
disablePublicIp Boolean: Optional. If true, no external IP will be assigned to this VM instance.
enableIpForwarding Boolean: Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
gpuDriverConfig GPUDriverConfigResponse: Optional. Configuration for GPU drivers.
machineType String: Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource
metadata Map<String,String>: Optional. Custom metadata to apply to this instance.
networkInterfaces List<NetworkInterfaceResponse>: Optional. The network interfaces for the VM. Supports only one interface.
serviceAccounts List<ServiceAccountResponse>: Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.
shieldedInstanceConfig ShieldedInstanceConfigResponse: Optional. Shielded VM configuration. Images using supported Shielded VM features.
tags List<String>: Optional. The Compute Engine tags to add to runtime (see Tagging instances).
vmImage VmImageResponse: Optional. Use a Compute Engine VM image to start the notebook instance.

acceleratorConfigs AcceleratorConfigResponse[]: 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. Currently supports only one accelerator configuration.
bootDisk BootDiskResponse: Optional. The boot disk for the VM.
containerImage ContainerImageResponse: Optional. Use a container image to start the notebook instance.
dataDisks DataDiskResponse[]: Optional. Data disks attached to the VM instance. Currently supports only one data disk.
disablePublicIp boolean: Optional. If true, no external IP will be assigned to this VM instance.
enableIpForwarding boolean: Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
gpuDriverConfig GPUDriverConfigResponse: Optional. Configuration for GPU drivers.
machineType string: Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource
metadata {[key: string]: string}: Optional. Custom metadata to apply to this instance.
networkInterfaces NetworkInterfaceResponse[]: Optional. The network interfaces for the VM. Supports only one interface.
serviceAccounts ServiceAccountResponse[]: Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.
shieldedInstanceConfig ShieldedInstanceConfigResponse: Optional. Shielded VM configuration. Images using supported Shielded VM features.
tags string[]: Optional. The Compute Engine tags to add to runtime (see Tagging instances).
vmImage VmImageResponse: Optional. Use a Compute Engine VM image to start the notebook instance.

accelerator_configs Sequence[AcceleratorConfigResponse]: 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. Currently supports only one accelerator configuration.
boot_disk BootDiskResponse: Optional. The boot disk for the VM.
container_image ContainerImageResponse: Optional. Use a container image to start the notebook instance.
data_disks Sequence[DataDiskResponse]: Optional. Data disks attached to the VM instance. Currently supports only one data disk.
disable_public_ip bool: Optional. If true, no external IP will be assigned to this VM instance.
enable_ip_forwarding bool: Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
gpu_driver_config GPUDriverConfigResponse: Optional. Configuration for GPU drivers.
machine_type str: Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource
metadata Mapping[str, str]: Optional. Custom metadata to apply to this instance.
network_interfaces Sequence[NetworkInterfaceResponse]: Optional. The network interfaces for the VM. Supports only one interface.
service_accounts Sequence[ServiceAccountResponse]: Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.
shielded_instance_config ShieldedInstanceConfigResponse: Optional. Shielded VM configuration. Images using supported Shielded VM features.
tags Sequence[str]: Optional. The Compute Engine tags to add to runtime (see Tagging instances).
vm_image VmImageResponse: Optional. Use a Compute Engine VM image to start the notebook instance.

acceleratorConfigs List<Property Map>: 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. Currently supports only one accelerator configuration.
bootDisk Property Map: Optional. The boot disk for the VM.
containerImage Property Map: Optional. Use a container image to start the notebook instance.
dataDisks List<Property Map>: Optional. Data disks attached to the VM instance. Currently supports only one data disk.
disablePublicIp Boolean: Optional. If true, no external IP will be assigned to this VM instance.
enableIpForwarding Boolean: Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
gpuDriverConfig Property Map: Optional. Configuration for GPU drivers.
machineType String: Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource
metadata Map<String>: Optional. Custom metadata to apply to this instance.
networkInterfaces List<Property Map>: Optional. The network interfaces for the VM. Supports only one interface.
serviceAccounts List<Property Map>: Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.
shieldedInstanceConfig Property Map: Optional. Shielded VM configuration. Images using supported Shielded VM features.
tags List<String>: Optional. The Compute Engine tags to add to runtime (see Tagging instances).
vmImage Property Map: Optional. Use a Compute Engine VM image to start the notebook instance.

NetworkInterfaceResponse

Network string: Optional. The name of the VPC that this VM instance is in. Format: projects/{project_id}/global/networks/{network_id}
NicType string: Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
Subnet string: Optional. The name of the subnet that this VM instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

Network string: Optional. The name of the VPC that this VM instance is in. Format: projects/{project_id}/global/networks/{network_id}
NicType string: Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
Subnet string: Optional. The name of the subnet that this VM instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

network String: Optional. The name of the VPC that this VM instance is in. Format: projects/{project_id}/global/networks/{network_id}
nicType String: Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
subnet String: Optional. The name of the subnet that this VM instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

network string: Optional. The name of the VPC that this VM instance is in. Format: projects/{project_id}/global/networks/{network_id}
nicType string: Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
subnet string: Optional. The name of the subnet that this VM instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

network str: Optional. The name of the VPC that this VM instance is in. Format: projects/{project_id}/global/networks/{network_id}
nic_type str: Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
subnet str: Optional. The name of the subnet that this VM instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

network String: Optional. The name of the VPC that this VM instance is in. Format: projects/{project_id}/global/networks/{network_id}
nicType String: Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
subnet String: Optional. The name of the subnet that this VM instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

ServiceAccountResponse

Email string: Optional. Email address of the service account.
Scopes List<string>: The list of scopes to be made available for this service account. Set by the CLH to https://www.googleapis.com/auth/cloud-platform

Email string: Optional. Email address of the service account.
Scopes []string: The list of scopes to be made available for this service account. Set by the CLH to https://www.googleapis.com/auth/cloud-platform

email String: Optional. Email address of the service account.
scopes List<String>: The list of scopes to be made available for this service account. Set by the CLH to https://www.googleapis.com/auth/cloud-platform

email string: Optional. Email address of the service account.
scopes string[]: The list of scopes to be made available for this service account. Set by the CLH to https://www.googleapis.com/auth/cloud-platform

email str: Optional. Email address of the service account.
scopes Sequence[str]: The list of scopes to be made available for this service account. Set by the CLH to https://www.googleapis.com/auth/cloud-platform

email String: Optional. Email address of the service account.
scopes List<String>: The list of scopes to be made available for this service account. Set by the CLH to https://www.googleapis.com/auth/cloud-platform

ShieldedInstanceConfigResponse

EnableIntegrityMonitoring bool: 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. Enabled by default.
EnableSecureBoot bool: 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.
EnableVtpm bool: Optional. Defines whether the VM instance has the vTPM enabled. Enabled by default.

EnableIntegrityMonitoring bool: 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. Enabled by default.
EnableSecureBoot bool: 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.
EnableVtpm bool: Optional. Defines whether the VM instance has the vTPM enabled. Enabled by default.

enableIntegrityMonitoring Boolean: 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. Enabled by default.
enableSecureBoot Boolean: 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.
enableVtpm Boolean: Optional. Defines whether the VM instance has the vTPM enabled. Enabled by default.

enableIntegrityMonitoring boolean: 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. Enabled by default.
enableSecureBoot boolean: 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.
enableVtpm boolean: Optional. Defines whether the VM instance has the vTPM enabled. Enabled by default.

enable_integrity_monitoring bool: 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. Enabled by default.
enable_secure_boot bool: 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 bool: Optional. Defines whether the VM instance has the vTPM enabled. Enabled by default.

enableIntegrityMonitoring Boolean: 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. Enabled by default.
enableSecureBoot Boolean: 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.
enableVtpm Boolean: Optional. Defines whether the VM instance has the vTPM enabled. Enabled by default.

UpgradeHistoryEntryResponse

Action string: Optional. Action. Rolloback or Upgrade.
ContainerImage string: Optional. The container image before this instance upgrade.
CreateTime string: Immutable. The time that this instance upgrade history entry is created.
Framework string: Optional. The framework of this notebook instance.
Snapshot string: Optional. The snapshot of the boot disk of this notebook instance before upgrade.
State string: The state of this instance upgrade history entry.
TargetVersion string: Optional. Target VM Version, like m63.
Version string: Optional. The version of the notebook instance before this upgrade.
VmImage string: Optional. The VM image before this instance upgrade.

Action string: Optional. Action. Rolloback or Upgrade.
ContainerImage string: Optional. The container image before this instance upgrade.
CreateTime string: Immutable. The time that this instance upgrade history entry is created.
Framework string: Optional. The framework of this notebook instance.
Snapshot string: Optional. The snapshot of the boot disk of this notebook instance before upgrade.
State string: The state of this instance upgrade history entry.
TargetVersion string: Optional. Target VM Version, like m63.
Version string: Optional. The version of the notebook instance before this upgrade.
VmImage string: Optional. The VM image before this instance upgrade.

action String: Optional. Action. Rolloback or Upgrade.
containerImage String: Optional. The container image before this instance upgrade.
createTime String: Immutable. The time that this instance upgrade history entry is created.
framework String: Optional. The framework of this notebook instance.
snapshot String: Optional. The snapshot of the boot disk of this notebook instance before upgrade.
state String: The state of this instance upgrade history entry.
targetVersion String: Optional. Target VM Version, like m63.
version String: Optional. The version of the notebook instance before this upgrade.
vmImage String: Optional. The VM image before this instance upgrade.

action string: Optional. Action. Rolloback or Upgrade.
containerImage string: Optional. The container image before this instance upgrade.
createTime string: Immutable. The time that this instance upgrade history entry is created.
framework string: Optional. The framework of this notebook instance.
snapshot string: Optional. The snapshot of the boot disk of this notebook instance before upgrade.
state string: The state of this instance upgrade history entry.
targetVersion string: Optional. Target VM Version, like m63.
version string: Optional. The version of the notebook instance before this upgrade.
vmImage string: Optional. The VM image before this instance upgrade.

action str: Optional. Action. Rolloback or Upgrade.
container_image str: Optional. The container image before this instance upgrade.
create_time str: Immutable. The time that this instance upgrade history entry is created.
framework str: Optional. The framework of this notebook instance.
snapshot str: Optional. The snapshot of the boot disk of this notebook instance before upgrade.
state str: The state of this instance upgrade history entry.
target_version str: Optional. Target VM Version, like m63.
version str: Optional. The version of the notebook instance before this upgrade.
vm_image str: Optional. The VM image before this instance upgrade.

action String: Optional. Action. Rolloback or Upgrade.
containerImage String: Optional. The container image before this instance upgrade.
createTime String: Immutable. The time that this instance upgrade history entry is created.
framework String: Optional. The framework of this notebook instance.
snapshot String: Optional. The snapshot of the boot disk of this notebook instance before upgrade.
state String: The state of this instance upgrade history entry.
targetVersion String: Optional. Target VM Version, like m63.
version String: Optional. The version of the notebook instance before this upgrade.
vmImage String: Optional. The VM image before this instance upgrade.

VmImageResponse

Family string: Optional. Use this VM image family to find the image; the newest image in this family will be used.
Name string: Optional. Use VM image name to find the image.
Project string: The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

Family string: Optional. Use this VM image family to find the image; the newest image in this family will be used.
Name string: Optional. Use VM image name to find the image.
Project string: The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

family String: Optional. Use this VM image family to find the image; the newest image in this family will be used.
name String: Optional. Use VM image name to find the image.
project String: The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

family string: Optional. Use this VM image family to find the image; the newest image in this family will be used.
name string: Optional. Use VM image name to find the image.
project string: The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

family str: Optional. Use this VM image family to find the image; the newest image in this family will be used.
name str: Optional. Use VM image name to find the image.
project str: The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

family String: Optional. Use this VM image family to find the image; the newest image in this family will be used.
name String: Optional. Use VM image name to find the image.
project String: The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.notebooks/v2.getInstance

On this page

On this page

Using getInstance

getInstance Result

Supporting Types

AcceleratorConfigResponse

BootDiskResponse

ContainerImageResponse

DataDiskResponse

GPUDriverConfigResponse

GceSetupResponse

NetworkInterfaceResponse

ServiceAccountResponse

ShieldedInstanceConfigResponse

UpgradeHistoryEntryResponse

VmImageResponse

Package Details

On this page

On this page