Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. notebooks
  5. Runtime
Google Cloud v8.14.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.notebooks.Runtime

Explore with Pulumi AI

Google Cloud v8.14.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-gcp

A Cloud AI Platform Notebook runtime.

Note: Due to limitations of the Notebooks Runtime API, many fields in this resource do not properly detect drift. These fields will also not appear in state once imported.

To get more information about Runtime, see:

Example Usage

Notebook Runtime Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const runtime = new gcp.notebooks.Runtime("runtime", {
    name: "notebooks-runtime",
    location: "us-central1",
    accessConfig: {
        accessType: "SINGLE_USER",
        runtimeOwner: "admin@hashicorptest.com",
    },
    virtualMachine: {
        virtualMachineConfig: {
            machineType: "n1-standard-4",
            dataDisk: {
                initializeParams: {
                    diskSizeGb: 100,
                    diskType: "PD_STANDARD",
                },
            },
        },
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

runtime = gcp.notebooks.Runtime("runtime",
    name="notebooks-runtime",
    location="us-central1",
    access_config={
        "access_type": "SINGLE_USER",
        "runtime_owner": "admin@hashicorptest.com",
    },
    virtual_machine={
        "virtual_machine_config": {
            "machine_type": "n1-standard-4",
            "data_disk": {
                "initialize_params": {
                    "disk_size_gb": 100,
                    "disk_type": "PD_STANDARD",
                },
            },
        },
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/notebooks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := notebooks.NewRuntime(ctx, "runtime", &notebooks.RuntimeArgs{
			Name:     pulumi.String("notebooks-runtime"),
			Location: pulumi.String("us-central1"),
			AccessConfig: &notebooks.RuntimeAccessConfigArgs{
				AccessType:   pulumi.String("SINGLE_USER"),
				RuntimeOwner: pulumi.String("admin@hashicorptest.com"),
			},
			VirtualMachine: &notebooks.RuntimeVirtualMachineArgs{
				VirtualMachineConfig: &notebooks.RuntimeVirtualMachineVirtualMachineConfigArgs{
					MachineType: pulumi.String("n1-standard-4"),
					DataDisk: &notebooks.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs{
						InitializeParams: &notebooks.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs{
							DiskSizeGb: pulumi.Int(100),
							DiskType:   pulumi.String("PD_STANDARD"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var runtime = new Gcp.Notebooks.Runtime("runtime", new()
    {
        Name = "notebooks-runtime",
        Location = "us-central1",
        AccessConfig = new Gcp.Notebooks.Inputs.RuntimeAccessConfigArgs
        {
            AccessType = "SINGLE_USER",
            RuntimeOwner = "admin@hashicorptest.com",
        },
        VirtualMachine = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineArgs
        {
            VirtualMachineConfig = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigArgs
            {
                MachineType = "n1-standard-4",
                DataDisk = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs
                {
                    InitializeParams = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs
                    {
                        DiskSizeGb = 100,
                        DiskType = "PD_STANDARD",
                    },
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.Runtime;
import com.pulumi.gcp.notebooks.RuntimeArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeAccessConfigArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var runtime = new Runtime("runtime", RuntimeArgs.builder()
            .name("notebooks-runtime")
            .location("us-central1")
            .accessConfig(RuntimeAccessConfigArgs.builder()
                .accessType("SINGLE_USER")
                .runtimeOwner("admin@hashicorptest.com")
                .build())
            .virtualMachine(RuntimeVirtualMachineArgs.builder()
                .virtualMachineConfig(RuntimeVirtualMachineVirtualMachineConfigArgs.builder()
                    .machineType("n1-standard-4")
                    .dataDisk(RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs.builder()
                        .initializeParams(RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs.builder()
                            .diskSizeGb("100")
                            .diskType("PD_STANDARD")
                            .build())
                        .build())
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  runtime:
    type: gcp:notebooks:Runtime
    properties:
      name: notebooks-runtime
      location: us-central1
      accessConfig:
        accessType: SINGLE_USER
        runtimeOwner: admin@hashicorptest.com
      virtualMachine:
        virtualMachineConfig:
          machineType: n1-standard-4
          dataDisk:
            initializeParams:
              diskSizeGb: '100'
              diskType: PD_STANDARD
Copy

Notebook Runtime Basic Gpu

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const runtimeGpu = new gcp.notebooks.Runtime("runtime_gpu", {
    name: "notebooks-runtime-gpu",
    location: "us-central1",
    accessConfig: {
        accessType: "SINGLE_USER",
        runtimeOwner: "admin@hashicorptest.com",
    },
    softwareConfig: {
        installGpuDriver: true,
    },
    virtualMachine: {
        virtualMachineConfig: {
            machineType: "n1-standard-4",
            dataDisk: {
                initializeParams: {
                    diskSizeGb: 100,
                    diskType: "PD_STANDARD",
                },
            },
            acceleratorConfig: {
                coreCount: 1,
                type: "NVIDIA_TESLA_V100",
            },
        },
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

runtime_gpu = gcp.notebooks.Runtime("runtime_gpu",
    name="notebooks-runtime-gpu",
    location="us-central1",
    access_config={
        "access_type": "SINGLE_USER",
        "runtime_owner": "admin@hashicorptest.com",
    },
    software_config={
        "install_gpu_driver": True,
    },
    virtual_machine={
        "virtual_machine_config": {
            "machine_type": "n1-standard-4",
            "data_disk": {
                "initialize_params": {
                    "disk_size_gb": 100,
                    "disk_type": "PD_STANDARD",
                },
            },
            "accelerator_config": {
                "core_count": 1,
                "type": "NVIDIA_TESLA_V100",
            },
        },
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/notebooks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := notebooks.NewRuntime(ctx, "runtime_gpu", &notebooks.RuntimeArgs{
			Name:     pulumi.String("notebooks-runtime-gpu"),
			Location: pulumi.String("us-central1"),
			AccessConfig: &notebooks.RuntimeAccessConfigArgs{
				AccessType:   pulumi.String("SINGLE_USER"),
				RuntimeOwner: pulumi.String("admin@hashicorptest.com"),
			},
			SoftwareConfig: &notebooks.RuntimeSoftwareConfigArgs{
				InstallGpuDriver: pulumi.Bool(true),
			},
			VirtualMachine: &notebooks.RuntimeVirtualMachineArgs{
				VirtualMachineConfig: &notebooks.RuntimeVirtualMachineVirtualMachineConfigArgs{
					MachineType: pulumi.String("n1-standard-4"),
					DataDisk: &notebooks.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs{
						InitializeParams: &notebooks.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs{
							DiskSizeGb: pulumi.Int(100),
							DiskType:   pulumi.String("PD_STANDARD"),
						},
					},
					AcceleratorConfig: &notebooks.RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfigArgs{
						CoreCount: pulumi.Int(1),
						Type:      pulumi.String("NVIDIA_TESLA_V100"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var runtimeGpu = new Gcp.Notebooks.Runtime("runtime_gpu", new()
    {
        Name = "notebooks-runtime-gpu",
        Location = "us-central1",
        AccessConfig = new Gcp.Notebooks.Inputs.RuntimeAccessConfigArgs
        {
            AccessType = "SINGLE_USER",
            RuntimeOwner = "admin@hashicorptest.com",
        },
        SoftwareConfig = new Gcp.Notebooks.Inputs.RuntimeSoftwareConfigArgs
        {
            InstallGpuDriver = true,
        },
        VirtualMachine = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineArgs
        {
            VirtualMachineConfig = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigArgs
            {
                MachineType = "n1-standard-4",
                DataDisk = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs
                {
                    InitializeParams = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs
                    {
                        DiskSizeGb = 100,
                        DiskType = "PD_STANDARD",
                    },
                },
                AcceleratorConfig = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfigArgs
                {
                    CoreCount = 1,
                    Type = "NVIDIA_TESLA_V100",
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.Runtime;
import com.pulumi.gcp.notebooks.RuntimeArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeAccessConfigArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeSoftwareConfigArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var runtimeGpu = new Runtime("runtimeGpu", RuntimeArgs.builder()
            .name("notebooks-runtime-gpu")
            .location("us-central1")
            .accessConfig(RuntimeAccessConfigArgs.builder()
                .accessType("SINGLE_USER")
                .runtimeOwner("admin@hashicorptest.com")
                .build())
            .softwareConfig(RuntimeSoftwareConfigArgs.builder()
                .installGpuDriver(true)
                .build())
            .virtualMachine(RuntimeVirtualMachineArgs.builder()
                .virtualMachineConfig(RuntimeVirtualMachineVirtualMachineConfigArgs.builder()
                    .machineType("n1-standard-4")
                    .dataDisk(RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs.builder()
                        .initializeParams(RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs.builder()
                            .diskSizeGb("100")
                            .diskType("PD_STANDARD")
                            .build())
                        .build())
                    .acceleratorConfig(RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfigArgs.builder()
                        .coreCount("1")
                        .type("NVIDIA_TESLA_V100")
                        .build())
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  runtimeGpu:
    type: gcp:notebooks:Runtime
    name: runtime_gpu
    properties:
      name: notebooks-runtime-gpu
      location: us-central1
      accessConfig:
        accessType: SINGLE_USER
        runtimeOwner: admin@hashicorptest.com
      softwareConfig:
        installGpuDriver: true
      virtualMachine:
        virtualMachineConfig:
          machineType: n1-standard-4
          dataDisk:
            initializeParams:
              diskSizeGb: '100'
              diskType: PD_STANDARD
          acceleratorConfig:
            coreCount: '1'
            type: NVIDIA_TESLA_V100
Copy

Notebook Runtime Basic Container

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const runtimeContainer = new gcp.notebooks.Runtime("runtime_container", {
    name: "notebooks-runtime-container",
    location: "us-central1",
    accessConfig: {
        accessType: "SINGLE_USER",
        runtimeOwner: "admin@hashicorptest.com",
    },
    virtualMachine: {
        virtualMachineConfig: {
            machineType: "n1-standard-4",
            dataDisk: {
                initializeParams: {
                    diskSizeGb: 100,
                    diskType: "PD_STANDARD",
                },
            },
            containerImages: [
                {
                    repository: "gcr.io/deeplearning-platform-release/base-cpu",
                    tag: "latest",
                },
                {
                    repository: "gcr.io/deeplearning-platform-release/beam-notebooks",
                    tag: "latest",
                },
            ],
        },
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

runtime_container = gcp.notebooks.Runtime("runtime_container",
    name="notebooks-runtime-container",
    location="us-central1",
    access_config={
        "access_type": "SINGLE_USER",
        "runtime_owner": "admin@hashicorptest.com",
    },
    virtual_machine={
        "virtual_machine_config": {
            "machine_type": "n1-standard-4",
            "data_disk": {
                "initialize_params": {
                    "disk_size_gb": 100,
                    "disk_type": "PD_STANDARD",
                },
            },
            "container_images": [
                {
                    "repository": "gcr.io/deeplearning-platform-release/base-cpu",
                    "tag": "latest",
                },
                {
                    "repository": "gcr.io/deeplearning-platform-release/beam-notebooks",
                    "tag": "latest",
                },
            ],
        },
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/notebooks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := notebooks.NewRuntime(ctx, "runtime_container", &notebooks.RuntimeArgs{
			Name:     pulumi.String("notebooks-runtime-container"),
			Location: pulumi.String("us-central1"),
			AccessConfig: &notebooks.RuntimeAccessConfigArgs{
				AccessType:   pulumi.String("SINGLE_USER"),
				RuntimeOwner: pulumi.String("admin@hashicorptest.com"),
			},
			VirtualMachine: &notebooks.RuntimeVirtualMachineArgs{
				VirtualMachineConfig: &notebooks.RuntimeVirtualMachineVirtualMachineConfigArgs{
					MachineType: pulumi.String("n1-standard-4"),
					DataDisk: &notebooks.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs{
						InitializeParams: &notebooks.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs{
							DiskSizeGb: pulumi.Int(100),
							DiskType:   pulumi.String("PD_STANDARD"),
						},
					},
					ContainerImages: notebooks.RuntimeVirtualMachineVirtualMachineConfigContainerImageArray{
						&notebooks.RuntimeVirtualMachineVirtualMachineConfigContainerImageArgs{
							Repository: pulumi.String("gcr.io/deeplearning-platform-release/base-cpu"),
							Tag:        pulumi.String("latest"),
						},
						&notebooks.RuntimeVirtualMachineVirtualMachineConfigContainerImageArgs{
							Repository: pulumi.String("gcr.io/deeplearning-platform-release/beam-notebooks"),
							Tag:        pulumi.String("latest"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var runtimeContainer = new Gcp.Notebooks.Runtime("runtime_container", new()
    {
        Name = "notebooks-runtime-container",
        Location = "us-central1",
        AccessConfig = new Gcp.Notebooks.Inputs.RuntimeAccessConfigArgs
        {
            AccessType = "SINGLE_USER",
            RuntimeOwner = "admin@hashicorptest.com",
        },
        VirtualMachine = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineArgs
        {
            VirtualMachineConfig = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigArgs
            {
                MachineType = "n1-standard-4",
                DataDisk = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs
                {
                    InitializeParams = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs
                    {
                        DiskSizeGb = 100,
                        DiskType = "PD_STANDARD",
                    },
                },
                ContainerImages = new[]
                {
                    new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigContainerImageArgs
                    {
                        Repository = "gcr.io/deeplearning-platform-release/base-cpu",
                        Tag = "latest",
                    },
                    new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigContainerImageArgs
                    {
                        Repository = "gcr.io/deeplearning-platform-release/beam-notebooks",
                        Tag = "latest",
                    },
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.Runtime;
import com.pulumi.gcp.notebooks.RuntimeArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeAccessConfigArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var runtimeContainer = new Runtime("runtimeContainer", RuntimeArgs.builder()
            .name("notebooks-runtime-container")
            .location("us-central1")
            .accessConfig(RuntimeAccessConfigArgs.builder()
                .accessType("SINGLE_USER")
                .runtimeOwner("admin@hashicorptest.com")
                .build())
            .virtualMachine(RuntimeVirtualMachineArgs.builder()
                .virtualMachineConfig(RuntimeVirtualMachineVirtualMachineConfigArgs.builder()
                    .machineType("n1-standard-4")
                    .dataDisk(RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs.builder()
                        .initializeParams(RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs.builder()
                            .diskSizeGb("100")
                            .diskType("PD_STANDARD")
                            .build())
                        .build())
                    .containerImages(                    
                        RuntimeVirtualMachineVirtualMachineConfigContainerImageArgs.builder()
                            .repository("gcr.io/deeplearning-platform-release/base-cpu")
                            .tag("latest")
                            .build(),
                        RuntimeVirtualMachineVirtualMachineConfigContainerImageArgs.builder()
                            .repository("gcr.io/deeplearning-platform-release/beam-notebooks")
                            .tag("latest")
                            .build())
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  runtimeContainer:
    type: gcp:notebooks:Runtime
    name: runtime_container
    properties:
      name: notebooks-runtime-container
      location: us-central1
      accessConfig:
        accessType: SINGLE_USER
        runtimeOwner: admin@hashicorptest.com
      virtualMachine:
        virtualMachineConfig:
          machineType: n1-standard-4
          dataDisk:
            initializeParams:
              diskSizeGb: '100'
              diskType: PD_STANDARD
          containerImages:
            - repository: gcr.io/deeplearning-platform-release/base-cpu
              tag: latest
            - repository: gcr.io/deeplearning-platform-release/beam-notebooks
              tag: latest
Copy

Notebook Runtime Kernels

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const runtimeContainer = new gcp.notebooks.Runtime("runtime_container", {
    name: "notebooks-runtime-kernel",
    location: "us-central1",
    accessConfig: {
        accessType: "SINGLE_USER",
        runtimeOwner: "admin@hashicorptest.com",
    },
    softwareConfig: {
        kernels: [{
            repository: "gcr.io/deeplearning-platform-release/base-cpu",
            tag: "latest",
        }],
    },
    virtualMachine: {
        virtualMachineConfig: {
            machineType: "n1-standard-4",
            dataDisk: {
                initializeParams: {
                    diskSizeGb: 100,
                    diskType: "PD_STANDARD",
                },
            },
        },
    },
    labels: {
        k: "val",
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

runtime_container = gcp.notebooks.Runtime("runtime_container",
    name="notebooks-runtime-kernel",
    location="us-central1",
    access_config={
        "access_type": "SINGLE_USER",
        "runtime_owner": "admin@hashicorptest.com",
    },
    software_config={
        "kernels": [{
            "repository": "gcr.io/deeplearning-platform-release/base-cpu",
            "tag": "latest",
        }],
    },
    virtual_machine={
        "virtual_machine_config": {
            "machine_type": "n1-standard-4",
            "data_disk": {
                "initialize_params": {
                    "disk_size_gb": 100,
                    "disk_type": "PD_STANDARD",
                },
            },
        },
    },
    labels={
        "k": "val",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/notebooks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := notebooks.NewRuntime(ctx, "runtime_container", &notebooks.RuntimeArgs{
			Name:     pulumi.String("notebooks-runtime-kernel"),
			Location: pulumi.String("us-central1"),
			AccessConfig: &notebooks.RuntimeAccessConfigArgs{
				AccessType:   pulumi.String("SINGLE_USER"),
				RuntimeOwner: pulumi.String("admin@hashicorptest.com"),
			},
			SoftwareConfig: &notebooks.RuntimeSoftwareConfigArgs{
				Kernels: notebooks.RuntimeSoftwareConfigKernelArray{
					&notebooks.RuntimeSoftwareConfigKernelArgs{
						Repository: pulumi.String("gcr.io/deeplearning-platform-release/base-cpu"),
						Tag:        pulumi.String("latest"),
					},
				},
			},
			VirtualMachine: &notebooks.RuntimeVirtualMachineArgs{
				VirtualMachineConfig: &notebooks.RuntimeVirtualMachineVirtualMachineConfigArgs{
					MachineType: pulumi.String("n1-standard-4"),
					DataDisk: &notebooks.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs{
						InitializeParams: &notebooks.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs{
							DiskSizeGb: pulumi.Int(100),
							DiskType:   pulumi.String("PD_STANDARD"),
						},
					},
				},
			},
			Labels: pulumi.StringMap{
				"k": pulumi.String("val"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var runtimeContainer = new Gcp.Notebooks.Runtime("runtime_container", new()
    {
        Name = "notebooks-runtime-kernel",
        Location = "us-central1",
        AccessConfig = new Gcp.Notebooks.Inputs.RuntimeAccessConfigArgs
        {
            AccessType = "SINGLE_USER",
            RuntimeOwner = "admin@hashicorptest.com",
        },
        SoftwareConfig = new Gcp.Notebooks.Inputs.RuntimeSoftwareConfigArgs
        {
            Kernels = new[]
            {
                new Gcp.Notebooks.Inputs.RuntimeSoftwareConfigKernelArgs
                {
                    Repository = "gcr.io/deeplearning-platform-release/base-cpu",
                    Tag = "latest",
                },
            },
        },
        VirtualMachine = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineArgs
        {
            VirtualMachineConfig = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigArgs
            {
                MachineType = "n1-standard-4",
                DataDisk = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs
                {
                    InitializeParams = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs
                    {
                        DiskSizeGb = 100,
                        DiskType = "PD_STANDARD",
                    },
                },
            },
        },
        Labels = 
        {
            { "k", "val" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.Runtime;
import com.pulumi.gcp.notebooks.RuntimeArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeAccessConfigArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeSoftwareConfigArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var runtimeContainer = new Runtime("runtimeContainer", RuntimeArgs.builder()
            .name("notebooks-runtime-kernel")
            .location("us-central1")
            .accessConfig(RuntimeAccessConfigArgs.builder()
                .accessType("SINGLE_USER")
                .runtimeOwner("admin@hashicorptest.com")
                .build())
            .softwareConfig(RuntimeSoftwareConfigArgs.builder()
                .kernels(RuntimeSoftwareConfigKernelArgs.builder()
                    .repository("gcr.io/deeplearning-platform-release/base-cpu")
                    .tag("latest")
                    .build())
                .build())
            .virtualMachine(RuntimeVirtualMachineArgs.builder()
                .virtualMachineConfig(RuntimeVirtualMachineVirtualMachineConfigArgs.builder()
                    .machineType("n1-standard-4")
                    .dataDisk(RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs.builder()
                        .initializeParams(RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs.builder()
                            .diskSizeGb("100")
                            .diskType("PD_STANDARD")
                            .build())
                        .build())
                    .build())
                .build())
            .labels(Map.of("k", "val"))
            .build());

    }
}
Copy
resources:
  runtimeContainer:
    type: gcp:notebooks:Runtime
    name: runtime_container
    properties:
      name: notebooks-runtime-kernel
      location: us-central1
      accessConfig:
        accessType: SINGLE_USER
        runtimeOwner: admin@hashicorptest.com
      softwareConfig:
        kernels:
          - repository: gcr.io/deeplearning-platform-release/base-cpu
            tag: latest
      virtualMachine:
        virtualMachineConfig:
          machineType: n1-standard-4
          dataDisk:
            initializeParams:
              diskSizeGb: '100'
              diskType: PD_STANDARD
      labels:
        k: val
Copy

Notebook Runtime Script

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const runtimeContainer = new gcp.notebooks.Runtime("runtime_container", {
    name: "notebooks-runtime-script",
    location: "us-central1",
    accessConfig: {
        accessType: "SINGLE_USER",
        runtimeOwner: "admin@hashicorptest.com",
    },
    softwareConfig: {
        postStartupScriptBehavior: "RUN_EVERY_START",
    },
    virtualMachine: {
        virtualMachineConfig: {
            machineType: "n1-standard-4",
            dataDisk: {
                initializeParams: {
                    diskSizeGb: 100,
                    diskType: "PD_STANDARD",
                },
            },
        },
    },
    labels: {
        k: "val",
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

runtime_container = gcp.notebooks.Runtime("runtime_container",
    name="notebooks-runtime-script",
    location="us-central1",
    access_config={
        "access_type": "SINGLE_USER",
        "runtime_owner": "admin@hashicorptest.com",
    },
    software_config={
        "post_startup_script_behavior": "RUN_EVERY_START",
    },
    virtual_machine={
        "virtual_machine_config": {
            "machine_type": "n1-standard-4",
            "data_disk": {
                "initialize_params": {
                    "disk_size_gb": 100,
                    "disk_type": "PD_STANDARD",
                },
            },
        },
    },
    labels={
        "k": "val",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/notebooks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := notebooks.NewRuntime(ctx, "runtime_container", &notebooks.RuntimeArgs{
			Name:     pulumi.String("notebooks-runtime-script"),
			Location: pulumi.String("us-central1"),
			AccessConfig: &notebooks.RuntimeAccessConfigArgs{
				AccessType:   pulumi.String("SINGLE_USER"),
				RuntimeOwner: pulumi.String("admin@hashicorptest.com"),
			},
			SoftwareConfig: &notebooks.RuntimeSoftwareConfigArgs{
				PostStartupScriptBehavior: pulumi.String("RUN_EVERY_START"),
			},
			VirtualMachine: &notebooks.RuntimeVirtualMachineArgs{
				VirtualMachineConfig: &notebooks.RuntimeVirtualMachineVirtualMachineConfigArgs{
					MachineType: pulumi.String("n1-standard-4"),
					DataDisk: &notebooks.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs{
						InitializeParams: &notebooks.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs{
							DiskSizeGb: pulumi.Int(100),
							DiskType:   pulumi.String("PD_STANDARD"),
						},
					},
				},
			},
			Labels: pulumi.StringMap{
				"k": pulumi.String("val"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var runtimeContainer = new Gcp.Notebooks.Runtime("runtime_container", new()
    {
        Name = "notebooks-runtime-script",
        Location = "us-central1",
        AccessConfig = new Gcp.Notebooks.Inputs.RuntimeAccessConfigArgs
        {
            AccessType = "SINGLE_USER",
            RuntimeOwner = "admin@hashicorptest.com",
        },
        SoftwareConfig = new Gcp.Notebooks.Inputs.RuntimeSoftwareConfigArgs
        {
            PostStartupScriptBehavior = "RUN_EVERY_START",
        },
        VirtualMachine = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineArgs
        {
            VirtualMachineConfig = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigArgs
            {
                MachineType = "n1-standard-4",
                DataDisk = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs
                {
                    InitializeParams = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs
                    {
                        DiskSizeGb = 100,
                        DiskType = "PD_STANDARD",
                    },
                },
            },
        },
        Labels = 
        {
            { "k", "val" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.Runtime;
import com.pulumi.gcp.notebooks.RuntimeArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeAccessConfigArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeSoftwareConfigArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs;
import com.pulumi.gcp.notebooks.inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var runtimeContainer = new Runtime("runtimeContainer", RuntimeArgs.builder()
            .name("notebooks-runtime-script")
            .location("us-central1")
            .accessConfig(RuntimeAccessConfigArgs.builder()
                .accessType("SINGLE_USER")
                .runtimeOwner("admin@hashicorptest.com")
                .build())
            .softwareConfig(RuntimeSoftwareConfigArgs.builder()
                .postStartupScriptBehavior("RUN_EVERY_START")
                .build())
            .virtualMachine(RuntimeVirtualMachineArgs.builder()
                .virtualMachineConfig(RuntimeVirtualMachineVirtualMachineConfigArgs.builder()
                    .machineType("n1-standard-4")
                    .dataDisk(RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs.builder()
                        .initializeParams(RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs.builder()
                            .diskSizeGb("100")
                            .diskType("PD_STANDARD")
                            .build())
                        .build())
                    .build())
                .build())
            .labels(Map.of("k", "val"))
            .build());

    }
}
Copy
resources:
  runtimeContainer:
    type: gcp:notebooks:Runtime
    name: runtime_container
    properties:
      name: notebooks-runtime-script
      location: us-central1
      accessConfig:
        accessType: SINGLE_USER
        runtimeOwner: admin@hashicorptest.com
      softwareConfig:
        postStartupScriptBehavior: RUN_EVERY_START
      virtualMachine:
        virtualMachineConfig:
          machineType: n1-standard-4
          dataDisk:
            initializeParams:
              diskSizeGb: '100'
              diskType: PD_STANDARD
      labels:
        k: val
Copy

Create Runtime Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Runtime(name: string, args: RuntimeArgs, opts?: CustomResourceOptions);
@overload
def Runtime(resource_name: str,
            args: RuntimeArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Runtime(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            location: Optional[str] = None,
            access_config: Optional[RuntimeAccessConfigArgs] = None,
            labels: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            software_config: Optional[RuntimeSoftwareConfigArgs] = None,
            virtual_machine: Optional[RuntimeVirtualMachineArgs] = None)
func NewRuntime(ctx *Context, name string, args RuntimeArgs, opts ...ResourceOption) (*Runtime, error)
public Runtime(string name, RuntimeArgs args, CustomResourceOptions? opts = null)
public Runtime(String name, RuntimeArgs args)
public Runtime(String name, RuntimeArgs args, CustomResourceOptions options)

type: gcp:notebooks:Runtime
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RuntimeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RuntimeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RuntimeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RuntimeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RuntimeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var runtimeResource = new Gcp.Notebooks.Runtime("runtimeResource", new()
{
    Location = "string",
    AccessConfig = new Gcp.Notebooks.Inputs.RuntimeAccessConfigArgs
    {
        AccessType = "string",
        ProxyUri = "string",
        RuntimeOwner = "string",
    },
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    Project = "string",
    SoftwareConfig = new Gcp.Notebooks.Inputs.RuntimeSoftwareConfigArgs
    {
        CustomGpuDriverPath = "string",
        EnableHealthMonitoring = false,
        IdleShutdown = false,
        IdleShutdownTimeout = 0,
        InstallGpuDriver = false,
        Kernels = new[]
        {
            new Gcp.Notebooks.Inputs.RuntimeSoftwareConfigKernelArgs
            {
                Repository = "string",
                Tag = "string",
            },
        },
        NotebookUpgradeSchedule = "string",
        PostStartupScript = "string",
        PostStartupScriptBehavior = "string",
        Upgradeable = false,
    },
    VirtualMachine = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineArgs
    {
        InstanceId = "string",
        InstanceName = "string",
        VirtualMachineConfig = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigArgs
        {
            DataDisk = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs
            {
                AutoDelete = false,
                Boot = false,
                DeviceName = "string",
                GuestOsFeatures = new[]
                {
                    "string",
                },
                Index = 0,
                InitializeParams = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs
                {
                    Description = "string",
                    DiskName = "string",
                    DiskSizeGb = 0,
                    DiskType = "string",
                    Labels = 
                    {
                        { "string", "string" },
                    },
                },
                Interface = "string",
                Kind = "string",
                Licenses = new[]
                {
                    "string",
                },
                Mode = "string",
                Source = "string",
                Type = "string",
            },
            MachineType = "string",
            Metadata = 
            {
                { "string", "string" },
            },
            Network = "string",
            GuestAttributes = 
            {
                { "string", "string" },
            },
            InternalIpOnly = false,
            Labels = 
            {
                { "string", "string" },
            },
            ContainerImages = new[]
            {
                new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigContainerImageArgs
                {
                    Repository = "string",
                    Tag = "string",
                },
            },
            AcceleratorConfig = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfigArgs
            {
                CoreCount = 0,
                Type = "string",
            },
            EncryptionConfig = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigEncryptionConfigArgs
            {
                KmsKey = "string",
            },
            NicType = "string",
            ReservedIpRange = "string",
            ShieldedInstanceConfig = new Gcp.Notebooks.Inputs.RuntimeVirtualMachineVirtualMachineConfigShieldedInstanceConfigArgs
            {
                EnableIntegrityMonitoring = false,
                EnableSecureBoot = false,
                EnableVtpm = false,
            },
            Subnet = "string",
            Tags = new[]
            {
                "string",
            },
            Zone = "string",
        },
    },
});
Copy
example, err := notebooks.NewRuntime(ctx, "runtimeResource", &notebooks.RuntimeArgs{
	Location: pulumi.String("string"),
	AccessConfig: &notebooks.RuntimeAccessConfigArgs{
		AccessType:   pulumi.String("string"),
		ProxyUri:     pulumi.String("string"),
		RuntimeOwner: pulumi.String("string"),
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:    pulumi.String("string"),
	Project: pulumi.String("string"),
	SoftwareConfig: &notebooks.RuntimeSoftwareConfigArgs{
		CustomGpuDriverPath:    pulumi.String("string"),
		EnableHealthMonitoring: pulumi.Bool(false),
		IdleShutdown:           pulumi.Bool(false),
		IdleShutdownTimeout:    pulumi.Int(0),
		InstallGpuDriver:       pulumi.Bool(false),
		Kernels: notebooks.RuntimeSoftwareConfigKernelArray{
			&notebooks.RuntimeSoftwareConfigKernelArgs{
				Repository: pulumi.String("string"),
				Tag:        pulumi.String("string"),
			},
		},
		NotebookUpgradeSchedule:   pulumi.String("string"),
		PostStartupScript:         pulumi.String("string"),
		PostStartupScriptBehavior: pulumi.String("string"),
		Upgradeable:               pulumi.Bool(false),
	},
	VirtualMachine: &notebooks.RuntimeVirtualMachineArgs{
		InstanceId:   pulumi.String("string"),
		InstanceName: pulumi.String("string"),
		VirtualMachineConfig: &notebooks.RuntimeVirtualMachineVirtualMachineConfigArgs{
			DataDisk: &notebooks.RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs{
				AutoDelete: pulumi.Bool(false),
				Boot:       pulumi.Bool(false),
				DeviceName: pulumi.String("string"),
				GuestOsFeatures: pulumi.StringArray{
					pulumi.String("string"),
				},
				Index: pulumi.Int(0),
				InitializeParams: &notebooks.RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs{
					Description: pulumi.String("string"),
					DiskName:    pulumi.String("string"),
					DiskSizeGb:  pulumi.Int(0),
					DiskType:    pulumi.String("string"),
					Labels: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
				},
				Interface: pulumi.String("string"),
				Kind:      pulumi.String("string"),
				Licenses: pulumi.StringArray{
					pulumi.String("string"),
				},
				Mode:   pulumi.String("string"),
				Source: pulumi.String("string"),
				Type:   pulumi.String("string"),
			},
			MachineType: pulumi.String("string"),
			Metadata: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Network: pulumi.String("string"),
			GuestAttributes: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			InternalIpOnly: pulumi.Bool(false),
			Labels: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			ContainerImages: notebooks.RuntimeVirtualMachineVirtualMachineConfigContainerImageArray{
				&notebooks.RuntimeVirtualMachineVirtualMachineConfigContainerImageArgs{
					Repository: pulumi.String("string"),
					Tag:        pulumi.String("string"),
				},
			},
			AcceleratorConfig: &notebooks.RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfigArgs{
				CoreCount: pulumi.Int(0),
				Type:      pulumi.String("string"),
			},
			EncryptionConfig: &notebooks.RuntimeVirtualMachineVirtualMachineConfigEncryptionConfigArgs{
				KmsKey: pulumi.String("string"),
			},
			NicType:         pulumi.String("string"),
			ReservedIpRange: pulumi.String("string"),
			ShieldedInstanceConfig: &notebooks.RuntimeVirtualMachineVirtualMachineConfigShieldedInstanceConfigArgs{
				EnableIntegrityMonitoring: pulumi.Bool(false),
				EnableSecureBoot:          pulumi.Bool(false),
				EnableVtpm:                pulumi.Bool(false),
			},
			Subnet: pulumi.String("string"),
			Tags: pulumi.StringArray{
				pulumi.String("string"),
			},
			Zone: pulumi.String("string"),
		},
	},
})
Copy
var runtimeResource = new Runtime("runtimeResource", RuntimeArgs.builder()
    .location("string")
    .accessConfig(RuntimeAccessConfigArgs.builder()
        .accessType("string")
        .proxyUri("string")
        .runtimeOwner("string")
        .build())
    .labels(Map.of("string", "string"))
    .name("string")
    .project("string")
    .softwareConfig(RuntimeSoftwareConfigArgs.builder()
        .customGpuDriverPath("string")
        .enableHealthMonitoring(false)
        .idleShutdown(false)
        .idleShutdownTimeout(0)
        .installGpuDriver(false)
        .kernels(RuntimeSoftwareConfigKernelArgs.builder()
            .repository("string")
            .tag("string")
            .build())
        .notebookUpgradeSchedule("string")
        .postStartupScript("string")
        .postStartupScriptBehavior("string")
        .upgradeable(false)
        .build())
    .virtualMachine(RuntimeVirtualMachineArgs.builder()
        .instanceId("string")
        .instanceName("string")
        .virtualMachineConfig(RuntimeVirtualMachineVirtualMachineConfigArgs.builder()
            .dataDisk(RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs.builder()
                .autoDelete(false)
                .boot(false)
                .deviceName("string")
                .guestOsFeatures("string")
                .index(0)
                .initializeParams(RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs.builder()
                    .description("string")
                    .diskName("string")
                    .diskSizeGb(0)
                    .diskType("string")
                    .labels(Map.of("string", "string"))
                    .build())
                .interface_("string")
                .kind("string")
                .licenses("string")
                .mode("string")
                .source("string")
                .type("string")
                .build())
            .machineType("string")
            .metadata(Map.of("string", "string"))
            .network("string")
            .guestAttributes(Map.of("string", "string"))
            .internalIpOnly(false)
            .labels(Map.of("string", "string"))
            .containerImages(RuntimeVirtualMachineVirtualMachineConfigContainerImageArgs.builder()
                .repository("string")
                .tag("string")
                .build())
            .acceleratorConfig(RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfigArgs.builder()
                .coreCount(0)
                .type("string")
                .build())
            .encryptionConfig(RuntimeVirtualMachineVirtualMachineConfigEncryptionConfigArgs.builder()
                .kmsKey("string")
                .build())
            .nicType("string")
            .reservedIpRange("string")
            .shieldedInstanceConfig(RuntimeVirtualMachineVirtualMachineConfigShieldedInstanceConfigArgs.builder()
                .enableIntegrityMonitoring(false)
                .enableSecureBoot(false)
                .enableVtpm(false)
                .build())
            .subnet("string")
            .tags("string")
            .zone("string")
            .build())
        .build())
    .build());
Copy
runtime_resource = gcp.notebooks.Runtime("runtimeResource",
    location="string",
    access_config={
        "access_type": "string",
        "proxy_uri": "string",
        "runtime_owner": "string",
    },
    labels={
        "string": "string",
    },
    name="string",
    project="string",
    software_config={
        "custom_gpu_driver_path": "string",
        "enable_health_monitoring": False,
        "idle_shutdown": False,
        "idle_shutdown_timeout": 0,
        "install_gpu_driver": False,
        "kernels": [{
            "repository": "string",
            "tag": "string",
        }],
        "notebook_upgrade_schedule": "string",
        "post_startup_script": "string",
        "post_startup_script_behavior": "string",
        "upgradeable": False,
    },
    virtual_machine={
        "instance_id": "string",
        "instance_name": "string",
        "virtual_machine_config": {
            "data_disk": {
                "auto_delete": False,
                "boot": False,
                "device_name": "string",
                "guest_os_features": ["string"],
                "index": 0,
                "initialize_params": {
                    "description": "string",
                    "disk_name": "string",
                    "disk_size_gb": 0,
                    "disk_type": "string",
                    "labels": {
                        "string": "string",
                    },
                },
                "interface": "string",
                "kind": "string",
                "licenses": ["string"],
                "mode": "string",
                "source": "string",
                "type": "string",
            },
            "machine_type": "string",
            "metadata": {
                "string": "string",
            },
            "network": "string",
            "guest_attributes": {
                "string": "string",
            },
            "internal_ip_only": False,
            "labels": {
                "string": "string",
            },
            "container_images": [{
                "repository": "string",
                "tag": "string",
            }],
            "accelerator_config": {
                "core_count": 0,
                "type": "string",
            },
            "encryption_config": {
                "kms_key": "string",
            },
            "nic_type": "string",
            "reserved_ip_range": "string",
            "shielded_instance_config": {
                "enable_integrity_monitoring": False,
                "enable_secure_boot": False,
                "enable_vtpm": False,
            },
            "subnet": "string",
            "tags": ["string"],
            "zone": "string",
        },
    })
Copy
const runtimeResource = new gcp.notebooks.Runtime("runtimeResource", {
    location: "string",
    accessConfig: {
        accessType: "string",
        proxyUri: "string",
        runtimeOwner: "string",
    },
    labels: {
        string: "string",
    },
    name: "string",
    project: "string",
    softwareConfig: {
        customGpuDriverPath: "string",
        enableHealthMonitoring: false,
        idleShutdown: false,
        idleShutdownTimeout: 0,
        installGpuDriver: false,
        kernels: [{
            repository: "string",
            tag: "string",
        }],
        notebookUpgradeSchedule: "string",
        postStartupScript: "string",
        postStartupScriptBehavior: "string",
        upgradeable: false,
    },
    virtualMachine: {
        instanceId: "string",
        instanceName: "string",
        virtualMachineConfig: {
            dataDisk: {
                autoDelete: false,
                boot: false,
                deviceName: "string",
                guestOsFeatures: ["string"],
                index: 0,
                initializeParams: {
                    description: "string",
                    diskName: "string",
                    diskSizeGb: 0,
                    diskType: "string",
                    labels: {
                        string: "string",
                    },
                },
                "interface": "string",
                kind: "string",
                licenses: ["string"],
                mode: "string",
                source: "string",
                type: "string",
            },
            machineType: "string",
            metadata: {
                string: "string",
            },
            network: "string",
            guestAttributes: {
                string: "string",
            },
            internalIpOnly: false,
            labels: {
                string: "string",
            },
            containerImages: [{
                repository: "string",
                tag: "string",
            }],
            acceleratorConfig: {
                coreCount: 0,
                type: "string",
            },
            encryptionConfig: {
                kmsKey: "string",
            },
            nicType: "string",
            reservedIpRange: "string",
            shieldedInstanceConfig: {
                enableIntegrityMonitoring: false,
                enableSecureBoot: false,
                enableVtpm: false,
            },
            subnet: "string",
            tags: ["string"],
            zone: "string",
        },
    },
});
Copy
type: gcp:notebooks:Runtime
properties:
    accessConfig:
        accessType: string
        proxyUri: string
        runtimeOwner: string
    labels:
        string: string
    location: string
    name: string
    project: string
    softwareConfig:
        customGpuDriverPath: string
        enableHealthMonitoring: false
        idleShutdown: false
        idleShutdownTimeout: 0
        installGpuDriver: false
        kernels:
            - repository: string
              tag: string
        notebookUpgradeSchedule: string
        postStartupScript: string
        postStartupScriptBehavior: string
        upgradeable: false
    virtualMachine:
        instanceId: string
        instanceName: string
        virtualMachineConfig:
            acceleratorConfig:
                coreCount: 0
                type: string
            containerImages:
                - repository: string
                  tag: string
            dataDisk:
                autoDelete: false
                boot: false
                deviceName: string
                guestOsFeatures:
                    - string
                index: 0
                initializeParams:
                    description: string
                    diskName: string
                    diskSizeGb: 0
                    diskType: string
                    labels:
                        string: string
                interface: string
                kind: string
                licenses:
                    - string
                mode: string
                source: string
                type: string
            encryptionConfig:
                kmsKey: string
            guestAttributes:
                string: string
            internalIpOnly: false
            labels:
                string: string
            machineType: string
            metadata:
                string: string
            network: string
            nicType: string
            reservedIpRange: string
            shieldedInstanceConfig:
                enableIntegrityMonitoring: false
                enableSecureBoot: false
                enableVtpm: false
            subnet: string
            tags:
                - string
            zone: string
Copy

Runtime Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Runtime resource accepts the following input properties:

Location
This property is required.
Changes to this property will trigger replacement.
string
A reference to the zone where the machine resides.

AccessConfig RuntimeAccessConfig
The config settings for accessing runtime. Structure is documented below.
Labels Dictionary<string, string>

The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Name Changes to this property will trigger replacement. string
The name specified for the Notebook runtime.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SoftwareConfig RuntimeSoftwareConfig
The config settings for software inside the runtime. Structure is documented below.
VirtualMachine RuntimeVirtualMachine
Use a Compute Engine VM image to start the managed notebook instance. Structure is documented below.
Location
This property is required.
Changes to this property will trigger replacement.
string
A reference to the zone where the machine resides.

AccessConfig RuntimeAccessConfigArgs
The config settings for accessing runtime. Structure is documented below.
Labels map[string]string

The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Name Changes to this property will trigger replacement. string
The name specified for the Notebook runtime.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SoftwareConfig RuntimeSoftwareConfigArgs
The config settings for software inside the runtime. Structure is documented below.
VirtualMachine RuntimeVirtualMachineArgs
Use a Compute Engine VM image to start the managed notebook instance. Structure is documented below.
location
This property is required.
Changes to this property will trigger replacement.
String
A reference to the zone where the machine resides.

accessConfig RuntimeAccessConfig
The config settings for accessing runtime. Structure is documented below.
labels Map<String,String>

The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

name Changes to this property will trigger replacement. String
The name specified for the Notebook runtime.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
softwareConfig RuntimeSoftwareConfig
The config settings for software inside the runtime. Structure is documented below.
virtualMachine RuntimeVirtualMachine
Use a Compute Engine VM image to start the managed notebook instance. Structure is documented below.
location
This property is required.
Changes to this property will trigger replacement.
string
A reference to the zone where the machine resides.

accessConfig RuntimeAccessConfig
The config settings for accessing runtime. Structure is documented below.
labels {[key: string]: string}

The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

name Changes to this property will trigger replacement. string
The name specified for the Notebook runtime.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
softwareConfig RuntimeSoftwareConfig
The config settings for software inside the runtime. Structure is documented below.
virtualMachine RuntimeVirtualMachine
Use a Compute Engine VM image to start the managed notebook instance. Structure is documented below.
location
This property is required.
Changes to this property will trigger replacement.
str
A reference to the zone where the machine resides.

access_config RuntimeAccessConfigArgs
The config settings for accessing runtime. Structure is documented below.
labels Mapping[str, str]

The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

name Changes to this property will trigger replacement. str
The name specified for the Notebook runtime.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
software_config RuntimeSoftwareConfigArgs
The config settings for software inside the runtime. Structure is documented below.
virtual_machine RuntimeVirtualMachineArgs
Use a Compute Engine VM image to start the managed notebook instance. Structure is documented below.
location
This property is required.
Changes to this property will trigger replacement.
String
A reference to the zone where the machine resides.

accessConfig Property Map
The config settings for accessing runtime. Structure is documented below.
labels Map<String>

The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

name Changes to this property will trigger replacement. String
The name specified for the Notebook runtime.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
softwareConfig Property Map
The config settings for software inside the runtime. Structure is documented below.
virtualMachine Property Map
Use a Compute Engine VM image to start the managed notebook instance. Structure is documented below.

Outputs

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

EffectiveLabels Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
HealthState string
The health state of this runtime. For a list of possible output values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#healthstate.
Id string
The provider-assigned unique ID for this managed resource.
Metrics List<RuntimeMetric>
Contains Runtime daemon metrics such as Service status and JupyterLab status Structure is documented below.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
State string
The state of this runtime.
EffectiveLabels map[string]string
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
HealthState string
The health state of this runtime. For a list of possible output values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#healthstate.
Id string
The provider-assigned unique ID for this managed resource.
Metrics []RuntimeMetric
Contains Runtime daemon metrics such as Service status and JupyterLab status Structure is documented below.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
State string
The state of this runtime.
effectiveLabels Map<String,String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
healthState String
The health state of this runtime. For a list of possible output values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#healthstate.
id String
The provider-assigned unique ID for this managed resource.
metrics List<RuntimeMetric>
Contains Runtime daemon metrics such as Service status and JupyterLab status Structure is documented below.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
state String
The state of this runtime.
effectiveLabels {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
healthState string
The health state of this runtime. For a list of possible output values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#healthstate.
id string
The provider-assigned unique ID for this managed resource.
metrics RuntimeMetric[]
Contains Runtime daemon metrics such as Service status and JupyterLab status Structure is documented below.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
state string
The state of this runtime.
effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
health_state str
The health state of this runtime. For a list of possible output values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#healthstate.
id str
The provider-assigned unique ID for this managed resource.
metrics Sequence[RuntimeMetric]
Contains Runtime daemon metrics such as Service status and JupyterLab status Structure is documented below.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
state str
The state of this runtime.
effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
healthState String
The health state of this runtime. For a list of possible output values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#healthstate.
id String
The provider-assigned unique ID for this managed resource.
metrics List<Property Map>
Contains Runtime daemon metrics such as Service status and JupyterLab status Structure is documented below.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
state String
The state of this runtime.

Look up Existing Runtime Resource

Get an existing Runtime 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?: RuntimeState, opts?: CustomResourceOptions): Runtime
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_config: Optional[RuntimeAccessConfigArgs] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        health_state: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        metrics: Optional[Sequence[RuntimeMetricArgs]] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        software_config: Optional[RuntimeSoftwareConfigArgs] = None,
        state: Optional[str] = None,
        virtual_machine: Optional[RuntimeVirtualMachineArgs] = None) -> Runtime
func GetRuntime(ctx *Context, name string, id IDInput, state *RuntimeState, opts ...ResourceOption) (*Runtime, error)
public static Runtime Get(string name, Input<string> id, RuntimeState? state, CustomResourceOptions? opts = null)
public static Runtime get(String name, Output<String> id, RuntimeState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AccessConfig RuntimeAccessConfig
The config settings for accessing runtime. Structure is documented below.
EffectiveLabels Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
HealthState string
The health state of this runtime. For a list of possible output values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#healthstate.
Labels Dictionary<string, string>

The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Location Changes to this property will trigger replacement. string
A reference to the zone where the machine resides.

Metrics List<RuntimeMetric>
Contains Runtime daemon metrics such as Service status and JupyterLab status Structure is documented below.
Name Changes to this property will trigger replacement. string
The name specified for the Notebook runtime.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
SoftwareConfig RuntimeSoftwareConfig
The config settings for software inside the runtime. Structure is documented below.
State string
The state of this runtime.
VirtualMachine RuntimeVirtualMachine
Use a Compute Engine VM image to start the managed notebook instance. Structure is documented below.
AccessConfig RuntimeAccessConfigArgs
The config settings for accessing runtime. Structure is documented below.
EffectiveLabels map[string]string
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
HealthState string
The health state of this runtime. For a list of possible output values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#healthstate.
Labels map[string]string

The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Location Changes to this property will trigger replacement. string
A reference to the zone where the machine resides.

Metrics []RuntimeMetricArgs
Contains Runtime daemon metrics such as Service status and JupyterLab status Structure is documented below.
Name Changes to this property will trigger replacement. string
The name specified for the Notebook runtime.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
SoftwareConfig RuntimeSoftwareConfigArgs
The config settings for software inside the runtime. Structure is documented below.
State string
The state of this runtime.
VirtualMachine RuntimeVirtualMachineArgs
Use a Compute Engine VM image to start the managed notebook instance. Structure is documented below.
accessConfig RuntimeAccessConfig
The config settings for accessing runtime. Structure is documented below.
effectiveLabels Map<String,String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
healthState String
The health state of this runtime. For a list of possible output values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#healthstate.
labels Map<String,String>

The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location Changes to this property will trigger replacement. String
A reference to the zone where the machine resides.

metrics List<RuntimeMetric>
Contains Runtime daemon metrics such as Service status and JupyterLab status Structure is documented below.
name Changes to this property will trigger replacement. String
The name specified for the Notebook runtime.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
softwareConfig RuntimeSoftwareConfig
The config settings for software inside the runtime. Structure is documented below.
state String
The state of this runtime.
virtualMachine RuntimeVirtualMachine
Use a Compute Engine VM image to start the managed notebook instance. Structure is documented below.
accessConfig RuntimeAccessConfig
The config settings for accessing runtime. Structure is documented below.
effectiveLabels {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
healthState string
The health state of this runtime. For a list of possible output values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#healthstate.
labels {[key: string]: string}

The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location Changes to this property will trigger replacement. string
A reference to the zone where the machine resides.

metrics RuntimeMetric[]
Contains Runtime daemon metrics such as Service status and JupyterLab status Structure is documented below.
name Changes to this property will trigger replacement. string
The name specified for the Notebook runtime.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
softwareConfig RuntimeSoftwareConfig
The config settings for software inside the runtime. Structure is documented below.
state string
The state of this runtime.
virtualMachine RuntimeVirtualMachine
Use a Compute Engine VM image to start the managed notebook instance. Structure is documented below.
access_config RuntimeAccessConfigArgs
The config settings for accessing runtime. Structure is documented below.
effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
health_state str
The health state of this runtime. For a list of possible output values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#healthstate.
labels Mapping[str, str]

The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location Changes to this property will trigger replacement. str
A reference to the zone where the machine resides.

metrics Sequence[RuntimeMetricArgs]
Contains Runtime daemon metrics such as Service status and JupyterLab status Structure is documented below.
name Changes to this property will trigger replacement. str
The name specified for the Notebook runtime.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
software_config RuntimeSoftwareConfigArgs
The config settings for software inside the runtime. Structure is documented below.
state str
The state of this runtime.
virtual_machine RuntimeVirtualMachineArgs
Use a Compute Engine VM image to start the managed notebook instance. Structure is documented below.
accessConfig Property Map
The config settings for accessing runtime. Structure is documented below.
effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
healthState String
The health state of this runtime. For a list of possible output values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#healthstate.
labels Map<String>

The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location Changes to this property will trigger replacement. String
A reference to the zone where the machine resides.

metrics List<Property Map>
Contains Runtime daemon metrics such as Service status and JupyterLab status Structure is documented below.
name Changes to this property will trigger replacement. String
The name specified for the Notebook runtime.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
softwareConfig Property Map
The config settings for software inside the runtime. Structure is documented below.
state String
The state of this runtime.
virtualMachine Property Map
Use a Compute Engine VM image to start the managed notebook instance. Structure is documented below.

Supporting Types

RuntimeAccessConfig
, RuntimeAccessConfigArgs

AccessType string
The type of access mode this instance. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/reference/ rest/v1/projects.locations.runtimes#RuntimeAccessType.
ProxyUri string
(Output) The proxy endpoint that is used to access the runtime.
RuntimeOwner string
The owner of this runtime after creation. Format: alias@example.com. Currently supports one owner only.
AccessType string
The type of access mode this instance. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/reference/ rest/v1/projects.locations.runtimes#RuntimeAccessType.
ProxyUri string
(Output) The proxy endpoint that is used to access the runtime.
RuntimeOwner string
The owner of this runtime after creation. Format: alias@example.com. Currently supports one owner only.
accessType String
The type of access mode this instance. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/reference/ rest/v1/projects.locations.runtimes#RuntimeAccessType.
proxyUri String
(Output) The proxy endpoint that is used to access the runtime.
runtimeOwner String
The owner of this runtime after creation. Format: alias@example.com. Currently supports one owner only.
accessType string
The type of access mode this instance. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/reference/ rest/v1/projects.locations.runtimes#RuntimeAccessType.
proxyUri string
(Output) The proxy endpoint that is used to access the runtime.
runtimeOwner string
The owner of this runtime after creation. Format: alias@example.com. Currently supports one owner only.
access_type str
The type of access mode this instance. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/reference/ rest/v1/projects.locations.runtimes#RuntimeAccessType.
proxy_uri str
(Output) The proxy endpoint that is used to access the runtime.
runtime_owner str
The owner of this runtime after creation. Format: alias@example.com. Currently supports one owner only.
accessType String
The type of access mode this instance. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/reference/ rest/v1/projects.locations.runtimes#RuntimeAccessType.
proxyUri String
(Output) The proxy endpoint that is used to access the runtime.
runtimeOwner String
The owner of this runtime after creation. Format: alias@example.com. Currently supports one owner only.

RuntimeMetric
, RuntimeMetricArgs

SystemMetrics Dictionary<string, string>
(Output) Contains runtime daemon metrics, such as OS and kernels and sessions stats.
SystemMetrics map[string]string
(Output) Contains runtime daemon metrics, such as OS and kernels and sessions stats.
systemMetrics Map<String,String>
(Output) Contains runtime daemon metrics, such as OS and kernels and sessions stats.
systemMetrics {[key: string]: string}
(Output) Contains runtime daemon metrics, such as OS and kernels and sessions stats.
system_metrics Mapping[str, str]
(Output) Contains runtime daemon metrics, such as OS and kernels and sessions stats.
systemMetrics Map<String>
(Output) Contains runtime daemon metrics, such as OS and kernels and sessions stats.

RuntimeSoftwareConfig
, RuntimeSoftwareConfigArgs

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.
EnableHealthMonitoring bool
Verifies core internal services are running. Default: True.
IdleShutdown bool
Runtime will automatically shutdown after idle_shutdown_time. Default: True
IdleShutdownTimeout int
Time in minutes to wait before shuting down runtime. Default: 180 minutes
InstallGpuDriver bool
Install Nvidia Driver automatically.
Kernels List<RuntimeSoftwareConfigKernel>
Use a list of container images to use as Kernels in the notebook instance. Structure is documented below.
NotebookUpgradeSchedule string
Cron expression in UTC timezone for schedule instance auto upgrade. Please follow the cron format.
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).
PostStartupScriptBehavior string
Behavior for the post startup script. Possible values are: POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED, RUN_EVERY_START, DOWNLOAD_AND_RUN_EVERY_START.
Upgradeable bool
(Output) Bool indicating whether an newer image is available in an image family.
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.
EnableHealthMonitoring bool
Verifies core internal services are running. Default: True.
IdleShutdown bool
Runtime will automatically shutdown after idle_shutdown_time. Default: True
IdleShutdownTimeout int
Time in minutes to wait before shuting down runtime. Default: 180 minutes
InstallGpuDriver bool
Install Nvidia Driver automatically.
Kernels []RuntimeSoftwareConfigKernel
Use a list of container images to use as Kernels in the notebook instance. Structure is documented below.
NotebookUpgradeSchedule string
Cron expression in UTC timezone for schedule instance auto upgrade. Please follow the cron format.
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).
PostStartupScriptBehavior string
Behavior for the post startup script. Possible values are: POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED, RUN_EVERY_START, DOWNLOAD_AND_RUN_EVERY_START.
Upgradeable bool
(Output) Bool indicating whether an newer image is available in an image family.
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.
enableHealthMonitoring Boolean
Verifies core internal services are running. Default: True.
idleShutdown Boolean
Runtime will automatically shutdown after idle_shutdown_time. Default: True
idleShutdownTimeout Integer
Time in minutes to wait before shuting down runtime. Default: 180 minutes
installGpuDriver Boolean
Install Nvidia Driver automatically.
kernels List<RuntimeSoftwareConfigKernel>
Use a list of container images to use as Kernels in the notebook instance. Structure is documented below.
notebookUpgradeSchedule String
Cron expression in UTC timezone for schedule instance auto upgrade. Please follow the cron format.
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).
postStartupScriptBehavior String
Behavior for the post startup script. Possible values are: POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED, RUN_EVERY_START, DOWNLOAD_AND_RUN_EVERY_START.
upgradeable Boolean
(Output) Bool indicating whether an newer image is available in an image family.
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.
enableHealthMonitoring boolean
Verifies core internal services are running. Default: True.
idleShutdown boolean
Runtime will automatically shutdown after idle_shutdown_time. Default: True
idleShutdownTimeout number
Time in minutes to wait before shuting down runtime. Default: 180 minutes
installGpuDriver boolean
Install Nvidia Driver automatically.
kernels RuntimeSoftwareConfigKernel[]
Use a list of container images to use as Kernels in the notebook instance. Structure is documented below.
notebookUpgradeSchedule string
Cron expression in UTC timezone for schedule instance auto upgrade. Please follow the cron format.
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).
postStartupScriptBehavior string
Behavior for the post startup script. Possible values are: POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED, RUN_EVERY_START, DOWNLOAD_AND_RUN_EVERY_START.
upgradeable boolean
(Output) Bool indicating whether an newer image is available in an image family.
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.
enable_health_monitoring bool
Verifies core internal services are running. Default: True.
idle_shutdown bool
Runtime will automatically shutdown after idle_shutdown_time. Default: True
idle_shutdown_timeout int
Time in minutes to wait before shuting down runtime. Default: 180 minutes
install_gpu_driver bool
Install Nvidia Driver automatically.
kernels Sequence[RuntimeSoftwareConfigKernel]
Use a list of container images to use as Kernels in the notebook instance. Structure is documented below.
notebook_upgrade_schedule str
Cron expression in UTC timezone for schedule instance auto upgrade. Please follow the cron format.
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).
post_startup_script_behavior str
Behavior for the post startup script. Possible values are: POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED, RUN_EVERY_START, DOWNLOAD_AND_RUN_EVERY_START.
upgradeable bool
(Output) Bool indicating whether an newer image is available in an image family.
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.
enableHealthMonitoring Boolean
Verifies core internal services are running. Default: True.
idleShutdown Boolean
Runtime will automatically shutdown after idle_shutdown_time. Default: True
idleShutdownTimeout Number
Time in minutes to wait before shuting down runtime. Default: 180 minutes
installGpuDriver Boolean
Install Nvidia Driver automatically.
kernels List<Property Map>
Use a list of container images to use as Kernels in the notebook instance. Structure is documented below.
notebookUpgradeSchedule String
Cron expression in UTC timezone for schedule instance auto upgrade. Please follow the cron format.
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).
postStartupScriptBehavior String
Behavior for the post startup script. Possible values are: POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED, RUN_EVERY_START, DOWNLOAD_AND_RUN_EVERY_START.
upgradeable Boolean
(Output) Bool indicating whether an newer image is available in an image family.

RuntimeSoftwareConfigKernel
, RuntimeSoftwareConfigKernelArgs

Repository This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.
repository This property is required. 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.

RuntimeVirtualMachine
, RuntimeVirtualMachineArgs

InstanceId string
(Output) The unique identifier of the Managed Compute Engine instance.
InstanceName string
(Output) The user-friendly name of the Managed Compute Engine instance.
VirtualMachineConfig RuntimeVirtualMachineVirtualMachineConfig
Virtual Machine configuration settings. Structure is documented below.
InstanceId string
(Output) The unique identifier of the Managed Compute Engine instance.
InstanceName string
(Output) The user-friendly name of the Managed Compute Engine instance.
VirtualMachineConfig RuntimeVirtualMachineVirtualMachineConfig
Virtual Machine configuration settings. Structure is documented below.
instanceId String
(Output) The unique identifier of the Managed Compute Engine instance.
instanceName String
(Output) The user-friendly name of the Managed Compute Engine instance.
virtualMachineConfig RuntimeVirtualMachineVirtualMachineConfig
Virtual Machine configuration settings. Structure is documented below.
instanceId string
(Output) The unique identifier of the Managed Compute Engine instance.
instanceName string
(Output) The user-friendly name of the Managed Compute Engine instance.
virtualMachineConfig RuntimeVirtualMachineVirtualMachineConfig
Virtual Machine configuration settings. Structure is documented below.
instance_id str
(Output) The unique identifier of the Managed Compute Engine instance.
instance_name str
(Output) The user-friendly name of the Managed Compute Engine instance.
virtual_machine_config RuntimeVirtualMachineVirtualMachineConfig
Virtual Machine configuration settings. Structure is documented below.
instanceId String
(Output) The unique identifier of the Managed Compute Engine instance.
instanceName String
(Output) The user-friendly name of the Managed Compute Engine instance.
virtualMachineConfig Property Map
Virtual Machine configuration settings. Structure is documented below.

RuntimeVirtualMachineVirtualMachineConfig
, RuntimeVirtualMachineVirtualMachineConfigArgs

DataDisk This property is required. RuntimeVirtualMachineVirtualMachineConfigDataDisk
Data disk option configuration settings. Structure is documented below.
MachineType This property is required. string
The Compute Engine machine type used for runtimes.
AcceleratorConfig RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfig
The Compute Engine accelerator configuration for this runtime. Structure is documented below.
ContainerImages Changes to this property will trigger replacement. List<RuntimeVirtualMachineVirtualMachineConfigContainerImage>
Use a list of container images to start the notebook instance. Structure is documented below.
EncryptionConfig Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigEncryptionConfig
Encryption settings for virtual machine data disk. Structure is documented below.
GuestAttributes Dictionary<string, string>
(Output) The Compute Engine guest attributes. (see [Project and instance guest attributes](https://cloud.google.com/compute/docs/ storing-retrieving-metadata#guest_attributes)).
InternalIpOnly Changes to this property will trigger replacement. bool
If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.
Labels Dictionary<string, string>
The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.
Metadata Dictionary<string, string>
The Compute Engine metadata entries to add to virtual machine. (see [Project and instance metadata](https://cloud.google.com /compute/docs/storing-retrieving-metadata#project_and_instance _metadata)).
Network Changes to this property will trigger replacement. string
The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/ regions/global/default
  • projects/[project_id]/regions/global/default Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:
  • Google Managed Network (Network & subnet are empty)
  • Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
  • Shared VPC (network & subnet are required). Requires configuring Private Service Access.
NicType Changes to this property will trigger replacement. string
The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
ReservedIpRange Changes to this property will trigger replacement. string
Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned.
ShieldedInstanceConfig Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigShieldedInstanceConfig
Shielded VM Instance configuration settings. Structure is documented below.
Subnet Changes to this property will trigger replacement. string
The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/ regions/us-east1/subnetworks/sub0
  • projects/[project_id]/regions/us-east1/subnetworks/sub0
Tags List<string>
The Compute Engine tags to add to runtime (see [Tagging instances] (https://cloud.google.com/compute/docs/ label-or-tag-resources#tags)).
Zone string
(Output) The zone where the virtual machine is located.
DataDisk This property is required. RuntimeVirtualMachineVirtualMachineConfigDataDisk
Data disk option configuration settings. Structure is documented below.
MachineType This property is required. string
The Compute Engine machine type used for runtimes.
AcceleratorConfig RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfig
The Compute Engine accelerator configuration for this runtime. Structure is documented below.
ContainerImages Changes to this property will trigger replacement. []RuntimeVirtualMachineVirtualMachineConfigContainerImage
Use a list of container images to start the notebook instance. Structure is documented below.
EncryptionConfig Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigEncryptionConfig
Encryption settings for virtual machine data disk. Structure is documented below.
GuestAttributes map[string]string
(Output) The Compute Engine guest attributes. (see [Project and instance guest attributes](https://cloud.google.com/compute/docs/ storing-retrieving-metadata#guest_attributes)).
InternalIpOnly Changes to this property will trigger replacement. bool
If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.
Labels map[string]string
The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.
Metadata map[string]string
The Compute Engine metadata entries to add to virtual machine. (see [Project and instance metadata](https://cloud.google.com /compute/docs/storing-retrieving-metadata#project_and_instance _metadata)).
Network Changes to this property will trigger replacement. string
The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/ regions/global/default
  • projects/[project_id]/regions/global/default Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:
  • Google Managed Network (Network & subnet are empty)
  • Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
  • Shared VPC (network & subnet are required). Requires configuring Private Service Access.
NicType Changes to this property will trigger replacement. string
The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
ReservedIpRange Changes to this property will trigger replacement. string
Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned.
ShieldedInstanceConfig Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigShieldedInstanceConfig
Shielded VM Instance configuration settings. Structure is documented below.
Subnet Changes to this property will trigger replacement. string
The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/ regions/us-east1/subnetworks/sub0
  • projects/[project_id]/regions/us-east1/subnetworks/sub0
Tags []string
The Compute Engine tags to add to runtime (see [Tagging instances] (https://cloud.google.com/compute/docs/ label-or-tag-resources#tags)).
Zone string
(Output) The zone where the virtual machine is located.
dataDisk This property is required. RuntimeVirtualMachineVirtualMachineConfigDataDisk
Data disk option configuration settings. Structure is documented below.
machineType This property is required. String
The Compute Engine machine type used for runtimes.
acceleratorConfig RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfig
The Compute Engine accelerator configuration for this runtime. Structure is documented below.
containerImages Changes to this property will trigger replacement. List<RuntimeVirtualMachineVirtualMachineConfigContainerImage>
Use a list of container images to start the notebook instance. Structure is documented below.
encryptionConfig Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigEncryptionConfig
Encryption settings for virtual machine data disk. Structure is documented below.
guestAttributes Map<String,String>
(Output) The Compute Engine guest attributes. (see [Project and instance guest attributes](https://cloud.google.com/compute/docs/ storing-retrieving-metadata#guest_attributes)).
internalIpOnly Changes to this property will trigger replacement. Boolean
If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.
labels Map<String,String>
The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.
metadata Map<String,String>
The Compute Engine metadata entries to add to virtual machine. (see [Project and instance metadata](https://cloud.google.com /compute/docs/storing-retrieving-metadata#project_and_instance _metadata)).
network Changes to this property will trigger replacement. String
The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/ regions/global/default
  • projects/[project_id]/regions/global/default Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:
  • Google Managed Network (Network & subnet are empty)
  • Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
  • Shared VPC (network & subnet are required). Requires configuring Private Service Access.
nicType Changes to this property will trigger replacement. String
The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
reservedIpRange Changes to this property will trigger replacement. String
Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned.
shieldedInstanceConfig Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigShieldedInstanceConfig
Shielded VM Instance configuration settings. Structure is documented below.
subnet Changes to this property will trigger replacement. String
The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/ regions/us-east1/subnetworks/sub0
  • projects/[project_id]/regions/us-east1/subnetworks/sub0
tags List<String>
The Compute Engine tags to add to runtime (see [Tagging instances] (https://cloud.google.com/compute/docs/ label-or-tag-resources#tags)).
zone String
(Output) The zone where the virtual machine is located.
dataDisk This property is required. RuntimeVirtualMachineVirtualMachineConfigDataDisk
Data disk option configuration settings. Structure is documented below.
machineType This property is required. string
The Compute Engine machine type used for runtimes.
acceleratorConfig RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfig
The Compute Engine accelerator configuration for this runtime. Structure is documented below.
containerImages Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigContainerImage[]
Use a list of container images to start the notebook instance. Structure is documented below.
encryptionConfig Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigEncryptionConfig
Encryption settings for virtual machine data disk. Structure is documented below.
guestAttributes {[key: string]: string}
(Output) The Compute Engine guest attributes. (see [Project and instance guest attributes](https://cloud.google.com/compute/docs/ storing-retrieving-metadata#guest_attributes)).
internalIpOnly Changes to this property will trigger replacement. boolean
If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.
labels {[key: string]: string}
The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.
metadata {[key: string]: string}
The Compute Engine metadata entries to add to virtual machine. (see [Project and instance metadata](https://cloud.google.com /compute/docs/storing-retrieving-metadata#project_and_instance _metadata)).
network Changes to this property will trigger replacement. string
The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/ regions/global/default
  • projects/[project_id]/regions/global/default Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:
  • Google Managed Network (Network & subnet are empty)
  • Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
  • Shared VPC (network & subnet are required). Requires configuring Private Service Access.
nicType Changes to this property will trigger replacement. string
The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
reservedIpRange Changes to this property will trigger replacement. string
Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned.
shieldedInstanceConfig Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigShieldedInstanceConfig
Shielded VM Instance configuration settings. Structure is documented below.
subnet Changes to this property will trigger replacement. string
The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/ regions/us-east1/subnetworks/sub0
  • projects/[project_id]/regions/us-east1/subnetworks/sub0
tags string[]
The Compute Engine tags to add to runtime (see [Tagging instances] (https://cloud.google.com/compute/docs/ label-or-tag-resources#tags)).
zone string
(Output) The zone where the virtual machine is located.
data_disk This property is required. RuntimeVirtualMachineVirtualMachineConfigDataDisk
Data disk option configuration settings. Structure is documented below.
machine_type This property is required. str
The Compute Engine machine type used for runtimes.
accelerator_config RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfig
The Compute Engine accelerator configuration for this runtime. Structure is documented below.
container_images Changes to this property will trigger replacement. Sequence[RuntimeVirtualMachineVirtualMachineConfigContainerImage]
Use a list of container images to start the notebook instance. Structure is documented below.
encryption_config Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigEncryptionConfig
Encryption settings for virtual machine data disk. Structure is documented below.
guest_attributes Mapping[str, str]
(Output) The Compute Engine guest attributes. (see [Project and instance guest attributes](https://cloud.google.com/compute/docs/ storing-retrieving-metadata#guest_attributes)).
internal_ip_only Changes to this property will trigger replacement. bool
If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.
labels Mapping[str, str]
The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.
metadata Mapping[str, str]
The Compute Engine metadata entries to add to virtual machine. (see [Project and instance metadata](https://cloud.google.com /compute/docs/storing-retrieving-metadata#project_and_instance _metadata)).
network Changes to this property will trigger replacement. str
The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/ regions/global/default
  • projects/[project_id]/regions/global/default Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:
  • Google Managed Network (Network & subnet are empty)
  • Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
  • Shared VPC (network & subnet are required). Requires configuring Private Service Access.
nic_type Changes to this property will trigger replacement. str
The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
reserved_ip_range Changes to this property will trigger replacement. str
Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned.
shielded_instance_config Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigShieldedInstanceConfig
Shielded VM Instance configuration settings. Structure is documented below.
subnet Changes to this property will trigger replacement. str
The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/ regions/us-east1/subnetworks/sub0
  • projects/[project_id]/regions/us-east1/subnetworks/sub0
tags Sequence[str]
The Compute Engine tags to add to runtime (see [Tagging instances] (https://cloud.google.com/compute/docs/ label-or-tag-resources#tags)).
zone str
(Output) The zone where the virtual machine is located.
dataDisk This property is required. Property Map
Data disk option configuration settings. Structure is documented below.
machineType This property is required. String
The Compute Engine machine type used for runtimes.
acceleratorConfig Property Map
The Compute Engine accelerator configuration for this runtime. Structure is documented below.
containerImages Changes to this property will trigger replacement. List<Property Map>
Use a list of container images to start the notebook instance. Structure is documented below.
encryptionConfig Changes to this property will trigger replacement. Property Map
Encryption settings for virtual machine data disk. Structure is documented below.
guestAttributes Map<String>
(Output) The Compute Engine guest attributes. (see [Project and instance guest attributes](https://cloud.google.com/compute/docs/ storing-retrieving-metadata#guest_attributes)).
internalIpOnly Changes to this property will trigger replacement. Boolean
If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.
labels Map<String>
The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to [RFC 1035] (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.
metadata Map<String>
The Compute Engine metadata entries to add to virtual machine. (see [Project and instance metadata](https://cloud.google.com /compute/docs/storing-retrieving-metadata#project_and_instance _metadata)).
network Changes to this property will trigger replacement. String
The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/ regions/global/default
  • projects/[project_id]/regions/global/default Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:
  • Google Managed Network (Network & subnet are empty)
  • Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
  • Shared VPC (network & subnet are required). Requires configuring Private Service Access.
nicType Changes to this property will trigger replacement. String
The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
reservedIpRange Changes to this property will trigger replacement. String
Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned.
shieldedInstanceConfig Changes to this property will trigger replacement. Property Map
Shielded VM Instance configuration settings. Structure is documented below.
subnet Changes to this property will trigger replacement. String
The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/ regions/us-east1/subnetworks/sub0
  • projects/[project_id]/regions/us-east1/subnetworks/sub0
tags List<String>
The Compute Engine tags to add to runtime (see [Tagging instances] (https://cloud.google.com/compute/docs/ label-or-tag-resources#tags)).
zone String
(Output) The zone where the virtual machine is located.

RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfig
, RuntimeVirtualMachineVirtualMachineConfigAcceleratorConfigArgs

CoreCount int
Count of cores of this accelerator.
Type string
Accelerator model. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/reference/ rest/v1/projects.locations.runtimes#AcceleratorType
CoreCount int
Count of cores of this accelerator.
Type string
Accelerator model. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/reference/ rest/v1/projects.locations.runtimes#AcceleratorType
coreCount Integer
Count of cores of this accelerator.
type String
Accelerator model. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/reference/ rest/v1/projects.locations.runtimes#AcceleratorType
coreCount number
Count of cores of this accelerator.
type string
Accelerator model. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/reference/ rest/v1/projects.locations.runtimes#AcceleratorType
core_count int
Count of cores of this accelerator.
type str
Accelerator model. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/reference/ rest/v1/projects.locations.runtimes#AcceleratorType
coreCount Number
Count of cores of this accelerator.
type String
Accelerator model. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/reference/ rest/v1/projects.locations.runtimes#AcceleratorType

RuntimeVirtualMachineVirtualMachineConfigContainerImage
, RuntimeVirtualMachineVirtualMachineConfigContainerImageArgs

Repository This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.
repository This property is required. 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.

RuntimeVirtualMachineVirtualMachineConfigDataDisk
, RuntimeVirtualMachineVirtualMachineConfigDataDiskArgs

AutoDelete bool
(Output) Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
Boot bool
(Output) Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
DeviceName string
(Output) Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
GuestOsFeatures List<string>
(Output) Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available features, read https://cloud.google.com/compute/docs/ images/create-delete-deprecate-private-images#guest-os-features options. ``
Index int
(Output) Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
InitializeParams Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParams
Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. Structure is documented below.
Interface string
"Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI".
Kind string
(Output) Type of the resource. Always compute#attachedDisk for attached disks.
Licenses List<string>
(Output) Output only. Any valid publicly visible licenses.
Mode string
The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
Source string
Specifies a valid partial or full URL to an existing Persistent Disk resource.
Type string
Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
AutoDelete bool
(Output) Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
Boot bool
(Output) Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
DeviceName string
(Output) Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
GuestOsFeatures []string
(Output) Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available features, read https://cloud.google.com/compute/docs/ images/create-delete-deprecate-private-images#guest-os-features options. ``
Index int
(Output) Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
InitializeParams Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParams
Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. Structure is documented below.
Interface string
"Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI".
Kind string
(Output) Type of the resource. Always compute#attachedDisk for attached disks.
Licenses []string
(Output) Output only. Any valid publicly visible licenses.
Mode string
The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
Source string
Specifies a valid partial or full URL to an existing Persistent Disk resource.
Type string
Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
autoDelete Boolean
(Output) Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
boot Boolean
(Output) Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
deviceName String
(Output) Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
guestOsFeatures List<String>
(Output) Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available features, read https://cloud.google.com/compute/docs/ images/create-delete-deprecate-private-images#guest-os-features options. ``
index Integer
(Output) Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
initializeParams Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParams
Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. Structure is documented below.
interface_ String
"Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI".
kind String
(Output) Type of the resource. Always compute#attachedDisk for attached disks.
licenses List<String>
(Output) Output only. Any valid publicly visible licenses.
mode String
The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
source String
Specifies a valid partial or full URL to an existing Persistent Disk resource.
type String
Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
autoDelete boolean
(Output) Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
boot boolean
(Output) Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
deviceName string
(Output) Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
guestOsFeatures string[]
(Output) Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available features, read https://cloud.google.com/compute/docs/ images/create-delete-deprecate-private-images#guest-os-features options. ``
index number
(Output) Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
initializeParams Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParams
Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. Structure is documented below.
interface string
"Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI".
kind string
(Output) Type of the resource. Always compute#attachedDisk for attached disks.
licenses string[]
(Output) Output only. Any valid publicly visible licenses.
mode string
The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
source string
Specifies a valid partial or full URL to an existing Persistent Disk resource.
type string
Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
auto_delete bool
(Output) Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
boot bool
(Output) Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
device_name str
(Output) Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
guest_os_features Sequence[str]
(Output) Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available features, read https://cloud.google.com/compute/docs/ images/create-delete-deprecate-private-images#guest-os-features options. ``
index int
(Output) Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
initialize_params Changes to this property will trigger replacement. RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParams
Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. Structure is documented below.
interface str
"Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI".
kind str
(Output) Type of the resource. Always compute#attachedDisk for attached disks.
licenses Sequence[str]
(Output) Output only. Any valid publicly visible licenses.
mode str
The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
source str
Specifies a valid partial or full URL to an existing Persistent Disk resource.
type str
Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
autoDelete Boolean
(Output) Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
boot Boolean
(Output) Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
deviceName String
(Output) Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
guestOsFeatures List<String>
(Output) Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available features, read https://cloud.google.com/compute/docs/ images/create-delete-deprecate-private-images#guest-os-features options. ``
index Number
(Output) Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
initializeParams Changes to this property will trigger replacement. Property Map
Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. Structure is documented below.
interface String
"Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI".
kind String
(Output) Type of the resource. Always compute#attachedDisk for attached disks.
licenses List<String>
(Output) Output only. Any valid publicly visible licenses.
mode String
The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
source String
Specifies a valid partial or full URL to an existing Persistent Disk resource.
type String
Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParams
, RuntimeVirtualMachineVirtualMachineConfigDataDiskInitializeParamsArgs

Description string
Provide this property when creating the disk.
DiskName string
Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.
DiskSizeGb int
Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.
DiskType string
The type of the boot disk attached to this runtime, defaults to standard persistent disk. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#disktype
Labels Dictionary<string, string>
Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
Description string
Provide this property when creating the disk.
DiskName string
Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.
DiskSizeGb int
Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.
DiskType string
The type of the boot disk attached to this runtime, defaults to standard persistent disk. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#disktype
Labels map[string]string
Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
description String
Provide this property when creating the disk.
diskName String
Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.
diskSizeGb Integer
Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.
diskType String
The type of the boot disk attached to this runtime, defaults to standard persistent disk. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#disktype
labels Map<String,String>
Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
description string
Provide this property when creating the disk.
diskName string
Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.
diskSizeGb number
Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.
diskType string
The type of the boot disk attached to this runtime, defaults to standard persistent disk. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#disktype
labels {[key: string]: string}
Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
description str
Provide this property when creating the disk.
disk_name str
Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.
disk_size_gb int
Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.
disk_type str
The type of the boot disk attached to this runtime, defaults to standard persistent disk. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#disktype
labels Mapping[str, str]
Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
description String
Provide this property when creating the disk.
diskName String
Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.
diskSizeGb Number
Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.
diskType String
The type of the boot disk attached to this runtime, defaults to standard persistent disk. For valid values, see https://cloud.google.com/vertex-ai/docs/workbench/ reference/rest/v1/projects.locations.runtimes#disktype
labels Map<String>
Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

RuntimeVirtualMachineVirtualMachineConfigEncryptionConfig
, RuntimeVirtualMachineVirtualMachineConfigEncryptionConfigArgs

KmsKey string
The Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a disks. It has the following format: projects/{PROJECT_ID}/locations/{REGION}/keyRings/ {KEY_RING_NAME}/cryptoKeys/{KEY_NAME}
KmsKey string
The Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a disks. It has the following format: projects/{PROJECT_ID}/locations/{REGION}/keyRings/ {KEY_RING_NAME}/cryptoKeys/{KEY_NAME}
kmsKey String
The Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a disks. It has the following format: projects/{PROJECT_ID}/locations/{REGION}/keyRings/ {KEY_RING_NAME}/cryptoKeys/{KEY_NAME}
kmsKey string
The Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a disks. It has the following format: projects/{PROJECT_ID}/locations/{REGION}/keyRings/ {KEY_RING_NAME}/cryptoKeys/{KEY_NAME}
kms_key str
The Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a disks. It has the following format: projects/{PROJECT_ID}/locations/{REGION}/keyRings/ {KEY_RING_NAME}/cryptoKeys/{KEY_NAME}
kmsKey String
The Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a disks. It has the following format: projects/{PROJECT_ID}/locations/{REGION}/keyRings/ {KEY_RING_NAME}/cryptoKeys/{KEY_NAME}

RuntimeVirtualMachineVirtualMachineConfigShieldedInstanceConfig
, RuntimeVirtualMachineVirtualMachineConfigShieldedInstanceConfigArgs

EnableIntegrityMonitoring bool
Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
EnableSecureBoot bool
Defines whether the 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
Defines whether the instance has the vTPM enabled. Enabled by default.
EnableIntegrityMonitoring bool
Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
EnableSecureBoot bool
Defines whether the 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
Defines whether the instance has the vTPM enabled. Enabled by default.
enableIntegrityMonitoring Boolean
Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
enableSecureBoot Boolean
Defines whether the 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
Defines whether the instance has the vTPM enabled. Enabled by default.
enableIntegrityMonitoring boolean
Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
enableSecureBoot boolean
Defines whether the 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
Defines whether the instance has the vTPM enabled. Enabled by default.
enable_integrity_monitoring bool
Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
enable_secure_boot bool
Defines whether the 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
Defines whether the instance has the vTPM enabled. Enabled by default.
enableIntegrityMonitoring Boolean
Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
enableSecureBoot Boolean
Defines whether the 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
Defines whether the instance has the vTPM enabled. Enabled by default.

Import

Runtime can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/runtimes/{{name}}

  • {{project}}/{{location}}/{{name}}

  • {{location}}/{{name}}

When using the pulumi import command, Runtime can be imported using one of the formats above. For example:

$ pulumi import gcp:notebooks/runtime:Runtime default projects/{{project}}/locations/{{location}}/runtimes/{{name}}
Copy
$ pulumi import gcp:notebooks/runtime:Runtime default {{project}}/{{location}}/{{name}}
Copy
$ pulumi import gcp:notebooks/runtime:Runtime default {{location}}/{{name}}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.14.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-gcp