1. Docs
  2. Reference
  3. API
  4. GCP
  5. notebooks
  6. Instance

Instance

Create a Instance Resource

new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
def Instance(resource_name, opts=None, accelerator_config=None, boot_disk_size_gb=None, boot_disk_type=None, container_image=None, create_time=None, custom_gpu_driver_path=None, data_disk_size_gb=None, data_disk_type=None, disk_encryption=None, install_gpu_driver=None, instance_owners=None, kms_key=None, labels=None, location=None, machine_type=None, metadata=None, name=None, network=None, no_proxy_access=None, no_public_ip=None, no_remove_data_disk=None, post_startup_script=None, project=None, service_account=None, subnet=None, update_time=None, vm_image=None, __props__=None);
func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Instance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Instance resource accepts the following input properties:

Location string

A reference to the zone where the machine resides.

MachineType string

A reference to a machine type which defines VM kind.

AcceleratorConfig InstanceAcceleratorConfigArgs

The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.

BootDiskSizeGb int

The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.

BootDiskType string

Possible disk types for notebook instances.

ContainerImage InstanceContainerImageArgs

Use a container image to start the notebook instance. Structure is documented below.

CreateTime string

Instance creation time

CustomGpuDriverPath string

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we’ll automatically choose from official GPU drivers.

DataDiskSizeGb int

The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

DataDiskType string

Possible disk types for notebook instances.

DiskEncryption string

Disk encryption method used on the boot and data disks, defaults to GMEK.

InstallGpuDriver bool

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

InstanceOwners string

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.

KmsKey string

The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Labels Dictionary<string, string>

Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Metadata Dictionary<string, string>

Custom metadata to apply to this instance. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Name string

The name specified for the Notebook instance.

Network string

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

NoProxyAccess bool

the notebook instance will not register with the proxy..

NoPublicIp bool

no public IP will be assigned to this instance.

NoRemoveDataDisk bool

If true, the data disk will not be auto deleted when deleting the instance.

PostStartupScript string

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

Project string

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}

ServiceAccount string

The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.

Subnet string

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

UpdateTime string

Instance update time.

VmImage InstanceVmImageArgs

Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

Location string

A reference to the zone where the machine resides.

MachineType string

A reference to a machine type which defines VM kind.

AcceleratorConfig InstanceAcceleratorConfig

The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.

BootDiskSizeGb int

The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.

BootDiskType string

Possible disk types for notebook instances.

ContainerImage InstanceContainerImage

Use a container image to start the notebook instance. Structure is documented below.

CreateTime string

Instance creation time

CustomGpuDriverPath string

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we’ll automatically choose from official GPU drivers.

DataDiskSizeGb int

The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

DataDiskType string

Possible disk types for notebook instances.

DiskEncryption string

Disk encryption method used on the boot and data disks, defaults to GMEK.

InstallGpuDriver bool

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

InstanceOwners string

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.

KmsKey string

The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Labels map[string]string

Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Metadata map[string]string

Custom metadata to apply to this instance. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Name string

The name specified for the Notebook instance.

Network string

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

NoProxyAccess bool

the notebook instance will not register with the proxy..

NoPublicIp bool

no public IP will be assigned to this instance.

NoRemoveDataDisk bool

If true, the data disk will not be auto deleted when deleting the instance.

PostStartupScript string

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

Project string

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}

ServiceAccount string

The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.

Subnet string

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

UpdateTime string

Instance update time.

VmImage InstanceVmImage

Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

location string

A reference to the zone where the machine resides.

machineType string

A reference to a machine type which defines VM kind.

acceleratorConfig InstanceAcceleratorConfig

The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.

bootDiskSizeGb number

The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.

bootDiskType string

Possible disk types for notebook instances.

containerImage InstanceContainerImage

Use a container image to start the notebook instance. Structure is documented below.

createTime string

Instance creation time

customGpuDriverPath string

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we’ll automatically choose from official GPU drivers.

dataDiskSizeGb number

The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

dataDiskType string

Possible disk types for notebook instances.

diskEncryption string

Disk encryption method used on the boot and data disks, defaults to GMEK.

installGpuDriver boolean

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

instanceOwners string

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.

kmsKey string

The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

labels {[key: string]: string}

Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

metadata {[key: string]: string}

Custom metadata to apply to this instance. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

name string

The name specified for the Notebook instance.

network string

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

noProxyAccess boolean

the notebook instance will not register with the proxy..

noPublicIp boolean

no public IP will be assigned to this instance.

noRemoveDataDisk boolean

If true, the data disk will not be auto deleted when deleting the instance.

postStartupScript string

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

project string

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}

serviceAccount string

The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.

subnet string

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

updateTime string

Instance update time.

vmImage InstanceVmImage

Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

location str

A reference to the zone where the machine resides.

machine_type str

A reference to a machine type which defines VM kind.

accelerator_config Dict[InstanceAcceleratorConfig]

The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.

boot_disk_size_gb float

The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.

boot_disk_type str

Possible disk types for notebook instances.

container_image Dict[InstanceContainerImage]

Use a container image to start the notebook instance. Structure is documented below.

create_time str

Instance creation time

custom_gpu_driver_path str

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we’ll automatically choose from official GPU drivers.

data_disk_size_gb float

The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

data_disk_type str

Possible disk types for notebook instances.

disk_encryption str

Disk encryption method used on the boot and data disks, defaults to GMEK.

install_gpu_driver bool

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

instance_owners str

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.

kms_key str

The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

labels Dict[str, str]

Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

metadata Dict[str, str]

Custom metadata to apply to this instance. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

name str

The name specified for the Notebook instance.

network str

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

no_proxy_access bool

the notebook instance will not register with the proxy..

no_public_ip bool

no public IP will be assigned to this instance.

no_remove_data_disk bool

If true, the data disk will not be auto deleted when deleting the instance.

post_startup_script str

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

project str

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}

service_account str

The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.

subnet str

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

update_time str

Instance update time.

vm_image Dict[InstanceVmImage]

Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
ProxyUri string

The proxy endpoint that is used to access the Jupyter notebook.

State string

The state of this instance.

Id string
The provider-assigned unique ID for this managed resource.
ProxyUri string

The proxy endpoint that is used to access the Jupyter notebook.

State string

The state of this instance.

id string
The provider-assigned unique ID for this managed resource.
proxyUri string

The proxy endpoint that is used to access the Jupyter notebook.

state string

The state of this instance.

id str
The provider-assigned unique ID for this managed resource.
proxy_uri str

The proxy endpoint that is used to access the Jupyter notebook.

state str

The state of this instance.

Look up an Existing Instance Resource

Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
static get(resource_name, id, opts=None, accelerator_config=None, boot_disk_size_gb=None, boot_disk_type=None, container_image=None, create_time=None, custom_gpu_driver_path=None, data_disk_size_gb=None, data_disk_type=None, disk_encryption=None, install_gpu_driver=None, instance_owners=None, kms_key=None, labels=None, location=None, machine_type=None, metadata=None, name=None, network=None, no_proxy_access=None, no_public_ip=None, no_remove_data_disk=None, post_startup_script=None, project=None, proxy_uri=None, service_account=None, state=None, subnet=None, update_time=None, vm_image=None, __props__=None);
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AcceleratorConfig InstanceAcceleratorConfigArgs

The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.

BootDiskSizeGb int

The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.

BootDiskType string

Possible disk types for notebook instances.

ContainerImage InstanceContainerImageArgs

Use a container image to start the notebook instance. Structure is documented below.

CreateTime string

Instance creation time

CustomGpuDriverPath string

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we’ll automatically choose from official GPU drivers.

DataDiskSizeGb int

The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

DataDiskType string

Possible disk types for notebook instances.

DiskEncryption string

Disk encryption method used on the boot and data disks, defaults to GMEK.

InstallGpuDriver bool

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

InstanceOwners string

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.

KmsKey string

The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Labels Dictionary<string, string>

Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Location string

A reference to the zone where the machine resides.

MachineType string

A reference to a machine type which defines VM kind.

Metadata Dictionary<string, string>

Custom metadata to apply to this instance. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Name string

The name specified for the Notebook instance.

Network string

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

NoProxyAccess bool

the notebook instance will not register with the proxy..

NoPublicIp bool

no public IP will be assigned to this instance.

NoRemoveDataDisk bool

If true, the data disk will not be auto deleted when deleting the instance.

PostStartupScript string

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

Project string

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}

ProxyUri string

The proxy endpoint that is used to access the Jupyter notebook.

ServiceAccount string

The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.

State string

The state of this instance.

Subnet string

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

UpdateTime string

Instance update time.

VmImage InstanceVmImageArgs

Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

AcceleratorConfig InstanceAcceleratorConfig

The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.

BootDiskSizeGb int

The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.

BootDiskType string

Possible disk types for notebook instances.

ContainerImage InstanceContainerImage

Use a container image to start the notebook instance. Structure is documented below.

CreateTime string

Instance creation time

CustomGpuDriverPath string

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we’ll automatically choose from official GPU drivers.

DataDiskSizeGb int

The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

DataDiskType string

Possible disk types for notebook instances.

DiskEncryption string

Disk encryption method used on the boot and data disks, defaults to GMEK.

InstallGpuDriver bool

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

InstanceOwners string

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.

KmsKey string

The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Labels map[string]string

Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Location string

A reference to the zone where the machine resides.

MachineType string

A reference to a machine type which defines VM kind.

Metadata map[string]string

Custom metadata to apply to this instance. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Name string

The name specified for the Notebook instance.

Network string

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

NoProxyAccess bool

the notebook instance will not register with the proxy..

NoPublicIp bool

no public IP will be assigned to this instance.

NoRemoveDataDisk bool

If true, the data disk will not be auto deleted when deleting the instance.

PostStartupScript string

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

Project string

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}

ProxyUri string

The proxy endpoint that is used to access the Jupyter notebook.

ServiceAccount string

The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.

State string

The state of this instance.

Subnet string

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

UpdateTime string

Instance update time.

VmImage InstanceVmImage

Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

acceleratorConfig InstanceAcceleratorConfig

The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.

bootDiskSizeGb number

The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.

bootDiskType string

Possible disk types for notebook instances.

containerImage InstanceContainerImage

Use a container image to start the notebook instance. Structure is documented below.

createTime string

Instance creation time

customGpuDriverPath string

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we’ll automatically choose from official GPU drivers.

dataDiskSizeGb number

The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

dataDiskType string

Possible disk types for notebook instances.

diskEncryption string

Disk encryption method used on the boot and data disks, defaults to GMEK.

installGpuDriver boolean

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

instanceOwners string

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.

kmsKey string

The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

labels {[key: string]: string}

Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

location string

A reference to the zone where the machine resides.

machineType string

A reference to a machine type which defines VM kind.

metadata {[key: string]: string}

Custom metadata to apply to this instance. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

name string

The name specified for the Notebook instance.

network string

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

noProxyAccess boolean

the notebook instance will not register with the proxy..

noPublicIp boolean

no public IP will be assigned to this instance.

noRemoveDataDisk boolean

If true, the data disk will not be auto deleted when deleting the instance.

postStartupScript string

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

project string

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}

proxyUri string

The proxy endpoint that is used to access the Jupyter notebook.

serviceAccount string

The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.

state string

The state of this instance.

subnet string

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

updateTime string

Instance update time.

vmImage InstanceVmImage

Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

accelerator_config Dict[InstanceAcceleratorConfig]

The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.

boot_disk_size_gb float

The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.

boot_disk_type str

Possible disk types for notebook instances.

container_image Dict[InstanceContainerImage]

Use a container image to start the notebook instance. Structure is documented below.

create_time str

Instance creation time

custom_gpu_driver_path str

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we’ll automatically choose from official GPU drivers.

data_disk_size_gb float

The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

data_disk_type str

Possible disk types for notebook instances.

disk_encryption str

Disk encryption method used on the boot and data disks, defaults to GMEK.

install_gpu_driver bool

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

instance_owners str

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.

kms_key str

The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

labels Dict[str, str]

Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

location str

A reference to the zone where the machine resides.

machine_type str

A reference to a machine type which defines VM kind.

metadata Dict[str, str]

Custom metadata to apply to this instance. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

name str

The name specified for the Notebook instance.

network str

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

no_proxy_access bool

the notebook instance will not register with the proxy..

no_public_ip bool

no public IP will be assigned to this instance.

no_remove_data_disk bool

If true, the data disk will not be auto deleted when deleting the instance.

post_startup_script str

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

project str

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}

proxy_uri str

The proxy endpoint that is used to access the Jupyter notebook.

service_account str

The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.

state str

The state of this instance.

subnet str

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

update_time str

Instance update time.

vm_image Dict[InstanceVmImage]

Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

Supporting Types

InstanceAcceleratorConfig

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

CoreCount int

Count of cores of this accelerator.

Type string

Type of this accelerator.

CoreCount int

Count of cores of this accelerator.

Type string

Type of this accelerator.

coreCount number

Count of cores of this accelerator.

type string

Type of this accelerator.

coreCount float

Count of cores of this accelerator.

type str

Type of this accelerator.

InstanceContainerImage

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Repository string

The path to the container image repository. For example: gcr.io/{project_id}/{imageName}

Tag string

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}/{imageName}

Tag string

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}/{imageName}

tag string

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}/{imageName}

tag str

The tag of the container image. If not specified, this defaults to the latest tag.

InstanceVmImage

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Project string

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}

ImageFamily string

Use this VM image family to find the image; the newest image in this family will be used.

ImageName string

Use VM image name to find the image.

Project string

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}

ImageFamily string

Use this VM image family to find the image; the newest image in this family will be used.

ImageName string

Use VM image name to find the image.

project string

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}

imageFamily string

Use this VM image family to find the image; the newest image in this family will be used.

imageName string

Use VM image name to find the image.

project str

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}

imageFamily str

Use this VM image family to find the image; the newest image in this family will be used.

imageName str

Use VM image name to find the image.

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.