Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. colab
  5. Runtime
Google Cloud v8.22.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.colab.Runtime

Explore with Pulumi AI

gcp logo
Google Cloud v8.22.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-gcp

    ‘A runtime is a Google-provisioned virtual machine (VM) that can run the code in your notebook (IPYNB file).’

    To get more information about Runtime, see:

    Example Usage

    Colab Runtime Basic

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

const myTemplate = new gcp.colab.RuntimeTemplate("my_template", {
    name: "colab-runtime",
    displayName: "Runtime template basic",
    location: "us-central1",
    machineSpec: {
        machineType: "e2-standard-4",
    },
    networkSpec: {
        enableInternetAccess: true,
    },
});
const runtime = new gcp.colab.Runtime("runtime", {
    name: "colab-runtime",
    location: "us-central1",
    notebookRuntimeTemplateRef: {
        notebookRuntimeTemplate: myTemplate.id,
    },
    displayName: "Runtime basic",
    runtimeUser: "gterraformtestuser@gmail.com",
}, {
    dependsOn: [myTemplate],
});

    import pulumi
import pulumi_gcp as gcp

my_template = gcp.colab.RuntimeTemplate("my_template",
    name="colab-runtime",
    display_name="Runtime template basic",
    location="us-central1",
    machine_spec={
        "machine_type": "e2-standard-4",
    },
    network_spec={
        "enable_internet_access": True,
    })
runtime = gcp.colab.Runtime("runtime",
    name="colab-runtime",
    location="us-central1",
    notebook_runtime_template_ref={
        "notebook_runtime_template": my_template.id,
    },
    display_name="Runtime basic",
    runtime_user="gterraformtestuser@gmail.com",
    opts = pulumi.ResourceOptions(depends_on=[my_template]))

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myTemplate, err := colab.NewRuntimeTemplate(ctx, "my_template", &colab.RuntimeTemplateArgs{
			Name:        pulumi.String("colab-runtime"),
			DisplayName: pulumi.String("Runtime template basic"),
			Location:    pulumi.String("us-central1"),
			MachineSpec: &colab.RuntimeTemplateMachineSpecArgs{
				MachineType: pulumi.String("e2-standard-4"),
			},
			NetworkSpec: &colab.RuntimeTemplateNetworkSpecArgs{
				EnableInternetAccess: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		_, err = colab.NewRuntime(ctx, "runtime", &colab.RuntimeArgs{
			Name:     pulumi.String("colab-runtime"),
			Location: pulumi.String("us-central1"),
			NotebookRuntimeTemplateRef: &colab.RuntimeNotebookRuntimeTemplateRefArgs{
				NotebookRuntimeTemplate: myTemplate.ID(),
			},
			DisplayName: pulumi.String("Runtime basic"),
			RuntimeUser: pulumi.String("gterraformtestuser@gmail.com"),
		}, pulumi.DependsOn([]pulumi.Resource{
			myTemplate,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var myTemplate = new Gcp.Colab.RuntimeTemplate("my_template", new()
    {
        Name = "colab-runtime",
        DisplayName = "Runtime template basic",
        Location = "us-central1",
        MachineSpec = new Gcp.Colab.Inputs.RuntimeTemplateMachineSpecArgs
        {
            MachineType = "e2-standard-4",
        },
        NetworkSpec = new Gcp.Colab.Inputs.RuntimeTemplateNetworkSpecArgs
        {
            EnableInternetAccess = true,
        },
    });

    var runtime = new Gcp.Colab.Runtime("runtime", new()
    {
        Name = "colab-runtime",
        Location = "us-central1",
        NotebookRuntimeTemplateRef = new Gcp.Colab.Inputs.RuntimeNotebookRuntimeTemplateRefArgs
        {
            NotebookRuntimeTemplate = myTemplate.Id,
        },
        DisplayName = "Runtime basic",
        RuntimeUser = "gterraformtestuser@gmail.com",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            myTemplate,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.colab.RuntimeTemplate;
import com.pulumi.gcp.colab.RuntimeTemplateArgs;
import com.pulumi.gcp.colab.inputs.RuntimeTemplateMachineSpecArgs;
import com.pulumi.gcp.colab.inputs.RuntimeTemplateNetworkSpecArgs;
import com.pulumi.gcp.colab.Runtime;
import com.pulumi.gcp.colab.RuntimeArgs;
import com.pulumi.gcp.colab.inputs.RuntimeNotebookRuntimeTemplateRefArgs;
import com.pulumi.resources.CustomResourceOptions;
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 myTemplate = new RuntimeTemplate("myTemplate", RuntimeTemplateArgs.builder()
            .name("colab-runtime")
            .displayName("Runtime template basic")
            .location("us-central1")
            .machineSpec(RuntimeTemplateMachineSpecArgs.builder()
                .machineType("e2-standard-4")
                .build())
            .networkSpec(RuntimeTemplateNetworkSpecArgs.builder()
                .enableInternetAccess(true)
                .build())
            .build());

        var runtime = new Runtime("runtime", RuntimeArgs.builder()
            .name("colab-runtime")
            .location("us-central1")
            .notebookRuntimeTemplateRef(RuntimeNotebookRuntimeTemplateRefArgs.builder()
                .notebookRuntimeTemplate(myTemplate.id())
                .build())
            .displayName("Runtime basic")
            .runtimeUser("gterraformtestuser@gmail.com")
            .build(), CustomResourceOptions.builder()
                .dependsOn(myTemplate)
                .build());

    }
}

    resources:
  myTemplate:
    type: gcp:colab:RuntimeTemplate
    name: my_template
    properties:
      name: colab-runtime
      displayName: Runtime template basic
      location: us-central1
      machineSpec:
        machineType: e2-standard-4
      networkSpec:
        enableInternetAccess: true
  runtime:
    type: gcp:colab:Runtime
    properties:
      name: colab-runtime
      location: us-central1
      notebookRuntimeTemplateRef:
        notebookRuntimeTemplate: ${myTemplate.id}
      displayName: Runtime basic
      runtimeUser: gterraformtestuser@gmail.com
    options:
      dependsOn:
        - ${myTemplate}

    Colab Runtime Stopped

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

const myTemplate = new gcp.colab.RuntimeTemplate("my_template", {
    name: "colab-runtime",
    displayName: "Runtime template basic",
    location: "us-central1",
    machineSpec: {
        machineType: "e2-standard-4",
    },
    networkSpec: {
        enableInternetAccess: true,
    },
});
const runtime = new gcp.colab.Runtime("runtime", {
    name: "colab-runtime",
    location: "us-central1",
    notebookRuntimeTemplateRef: {
        notebookRuntimeTemplate: myTemplate.id,
    },
    desiredState: "STOPPED",
    displayName: "Runtime stopped",
    runtimeUser: "gterraformtestuser@gmail.com",
}, {
    dependsOn: [myTemplate],
});

    import pulumi
import pulumi_gcp as gcp

my_template = gcp.colab.RuntimeTemplate("my_template",
    name="colab-runtime",
    display_name="Runtime template basic",
    location="us-central1",
    machine_spec={
        "machine_type": "e2-standard-4",
    },
    network_spec={
        "enable_internet_access": True,
    })
runtime = gcp.colab.Runtime("runtime",
    name="colab-runtime",
    location="us-central1",
    notebook_runtime_template_ref={
        "notebook_runtime_template": my_template.id,
    },
    desired_state="STOPPED",
    display_name="Runtime stopped",
    runtime_user="gterraformtestuser@gmail.com",
    opts = pulumi.ResourceOptions(depends_on=[my_template]))

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myTemplate, err := colab.NewRuntimeTemplate(ctx, "my_template", &colab.RuntimeTemplateArgs{
			Name:        pulumi.String("colab-runtime"),
			DisplayName: pulumi.String("Runtime template basic"),
			Location:    pulumi.String("us-central1"),
			MachineSpec: &colab.RuntimeTemplateMachineSpecArgs{
				MachineType: pulumi.String("e2-standard-4"),
			},
			NetworkSpec: &colab.RuntimeTemplateNetworkSpecArgs{
				EnableInternetAccess: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		_, err = colab.NewRuntime(ctx, "runtime", &colab.RuntimeArgs{
			Name:     pulumi.String("colab-runtime"),
			Location: pulumi.String("us-central1"),
			NotebookRuntimeTemplateRef: &colab.RuntimeNotebookRuntimeTemplateRefArgs{
				NotebookRuntimeTemplate: myTemplate.ID(),
			},
			DesiredState: pulumi.String("STOPPED"),
			DisplayName:  pulumi.String("Runtime stopped"),
			RuntimeUser:  pulumi.String("gterraformtestuser@gmail.com"),
		}, pulumi.DependsOn([]pulumi.Resource{
			myTemplate,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var myTemplate = new Gcp.Colab.RuntimeTemplate("my_template", new()
    {
        Name = "colab-runtime",
        DisplayName = "Runtime template basic",
        Location = "us-central1",
        MachineSpec = new Gcp.Colab.Inputs.RuntimeTemplateMachineSpecArgs
        {
            MachineType = "e2-standard-4",
        },
        NetworkSpec = new Gcp.Colab.Inputs.RuntimeTemplateNetworkSpecArgs
        {
            EnableInternetAccess = true,
        },
    });

    var runtime = new Gcp.Colab.Runtime("runtime", new()
    {
        Name = "colab-runtime",
        Location = "us-central1",
        NotebookRuntimeTemplateRef = new Gcp.Colab.Inputs.RuntimeNotebookRuntimeTemplateRefArgs
        {
            NotebookRuntimeTemplate = myTemplate.Id,
        },
        DesiredState = "STOPPED",
        DisplayName = "Runtime stopped",
        RuntimeUser = "gterraformtestuser@gmail.com",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            myTemplate,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.colab.RuntimeTemplate;
import com.pulumi.gcp.colab.RuntimeTemplateArgs;
import com.pulumi.gcp.colab.inputs.RuntimeTemplateMachineSpecArgs;
import com.pulumi.gcp.colab.inputs.RuntimeTemplateNetworkSpecArgs;
import com.pulumi.gcp.colab.Runtime;
import com.pulumi.gcp.colab.RuntimeArgs;
import com.pulumi.gcp.colab.inputs.RuntimeNotebookRuntimeTemplateRefArgs;
import com.pulumi.resources.CustomResourceOptions;
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 myTemplate = new RuntimeTemplate("myTemplate", RuntimeTemplateArgs.builder()
            .name("colab-runtime")
            .displayName("Runtime template basic")
            .location("us-central1")
            .machineSpec(RuntimeTemplateMachineSpecArgs.builder()
                .machineType("e2-standard-4")
                .build())
            .networkSpec(RuntimeTemplateNetworkSpecArgs.builder()
                .enableInternetAccess(true)
                .build())
            .build());

        var runtime = new Runtime("runtime", RuntimeArgs.builder()
            .name("colab-runtime")
            .location("us-central1")
            .notebookRuntimeTemplateRef(RuntimeNotebookRuntimeTemplateRefArgs.builder()
                .notebookRuntimeTemplate(myTemplate.id())
                .build())
            .desiredState("STOPPED")
            .displayName("Runtime stopped")
            .runtimeUser("gterraformtestuser@gmail.com")
            .build(), CustomResourceOptions.builder()
                .dependsOn(myTemplate)
                .build());

    }
}

    resources:
  myTemplate:
    type: gcp:colab:RuntimeTemplate
    name: my_template
    properties:
      name: colab-runtime
      displayName: Runtime template basic
      location: us-central1
      machineSpec:
        machineType: e2-standard-4
      networkSpec:
        enableInternetAccess: true
  runtime:
    type: gcp:colab:Runtime
    properties:
      name: colab-runtime
      location: us-central1
      notebookRuntimeTemplateRef:
        notebookRuntimeTemplate: ${myTemplate.id}
      desiredState: STOPPED
      displayName: Runtime stopped
      runtimeUser: gterraformtestuser@gmail.com
    options:
      dependsOn:
        - ${myTemplate}

    Colab Runtime Full

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

const myTemplate = new gcp.colab.RuntimeTemplate("my_template", {
    name: "colab-runtime",
    displayName: "Runtime template full",
    location: "us-central1",
    description: "Full runtime template",
    machineSpec: {
        machineType: "n1-standard-2",
        acceleratorType: "NVIDIA_TESLA_T4",
        acceleratorCount: 1,
    },
    dataPersistentDiskSpec: {
        diskType: "pd-standard",
        diskSizeGb: "200",
    },
    networkSpec: {
        enableInternetAccess: true,
    },
    labels: {
        k: "val",
    },
    idleShutdownConfig: {
        idleTimeout: "3600s",
    },
    eucConfig: {
        eucDisabled: true,
    },
    shieldedVmConfig: {
        enableSecureBoot: true,
    },
    networkTags: [
        "abc",
        "def",
    ],
    encryptionSpec: {
        kmsKeyName: "my-crypto-key",
    },
});
const runtime = new gcp.colab.Runtime("runtime", {
    name: "colab-runtime",
    location: "us-central1",
    notebookRuntimeTemplateRef: {
        notebookRuntimeTemplate: myTemplate.id,
    },
    displayName: "Runtime full",
    runtimeUser: "gterraformtestuser@gmail.com",
    description: "Full runtime",
    desiredState: "ACTIVE",
    autoUpgrade: true,
}, {
    dependsOn: [myTemplate],
});

    import pulumi
import pulumi_gcp as gcp

my_template = gcp.colab.RuntimeTemplate("my_template",
    name="colab-runtime",
    display_name="Runtime template full",
    location="us-central1",
    description="Full runtime template",
    machine_spec={
        "machine_type": "n1-standard-2",
        "accelerator_type": "NVIDIA_TESLA_T4",
        "accelerator_count": 1,
    },
    data_persistent_disk_spec={
        "disk_type": "pd-standard",
        "disk_size_gb": "200",
    },
    network_spec={
        "enable_internet_access": True,
    },
    labels={
        "k": "val",
    },
    idle_shutdown_config={
        "idle_timeout": "3600s",
    },
    euc_config={
        "euc_disabled": True,
    },
    shielded_vm_config={
        "enable_secure_boot": True,
    },
    network_tags=[
        "abc",
        "def",
    ],
    encryption_spec={
        "kms_key_name": "my-crypto-key",
    })
runtime = gcp.colab.Runtime("runtime",
    name="colab-runtime",
    location="us-central1",
    notebook_runtime_template_ref={
        "notebook_runtime_template": my_template.id,
    },
    display_name="Runtime full",
    runtime_user="gterraformtestuser@gmail.com",
    description="Full runtime",
    desired_state="ACTIVE",
    auto_upgrade=True,
    opts = pulumi.ResourceOptions(depends_on=[my_template]))

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myTemplate, err := colab.NewRuntimeTemplate(ctx, "my_template", &colab.RuntimeTemplateArgs{
			Name:        pulumi.String("colab-runtime"),
			DisplayName: pulumi.String("Runtime template full"),
			Location:    pulumi.String("us-central1"),
			Description: pulumi.String("Full runtime template"),
			MachineSpec: &colab.RuntimeTemplateMachineSpecArgs{
				MachineType:      pulumi.String("n1-standard-2"),
				AcceleratorType:  pulumi.String("NVIDIA_TESLA_T4"),
				AcceleratorCount: pulumi.Int(1),
			},
			DataPersistentDiskSpec: &colab.RuntimeTemplateDataPersistentDiskSpecArgs{
				DiskType:   pulumi.String("pd-standard"),
				DiskSizeGb: pulumi.String("200"),
			},
			NetworkSpec: &colab.RuntimeTemplateNetworkSpecArgs{
				EnableInternetAccess: pulumi.Bool(true),
			},
			Labels: pulumi.StringMap{
				"k": pulumi.String("val"),
			},
			IdleShutdownConfig: &colab.RuntimeTemplateIdleShutdownConfigArgs{
				IdleTimeout: pulumi.String("3600s"),
			},
			EucConfig: &colab.RuntimeTemplateEucConfigArgs{
				EucDisabled: pulumi.Bool(true),
			},
			ShieldedVmConfig: &colab.RuntimeTemplateShieldedVmConfigArgs{
				EnableSecureBoot: pulumi.Bool(true),
			},
			NetworkTags: pulumi.StringArray{
				pulumi.String("abc"),
				pulumi.String("def"),
			},
			EncryptionSpec: &colab.RuntimeTemplateEncryptionSpecArgs{
				KmsKeyName: pulumi.String("my-crypto-key"),
			},
		})
		if err != nil {
			return err
		}
		_, err = colab.NewRuntime(ctx, "runtime", &colab.RuntimeArgs{
			Name:     pulumi.String("colab-runtime"),
			Location: pulumi.String("us-central1"),
			NotebookRuntimeTemplateRef: &colab.RuntimeNotebookRuntimeTemplateRefArgs{
				NotebookRuntimeTemplate: myTemplate.ID(),
			},
			DisplayName:  pulumi.String("Runtime full"),
			RuntimeUser:  pulumi.String("gterraformtestuser@gmail.com"),
			Description:  pulumi.String("Full runtime"),
			DesiredState: pulumi.String("ACTIVE"),
			AutoUpgrade:  pulumi.Bool(true),
		}, pulumi.DependsOn([]pulumi.Resource{
			myTemplate,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var myTemplate = new Gcp.Colab.RuntimeTemplate("my_template", new()
    {
        Name = "colab-runtime",
        DisplayName = "Runtime template full",
        Location = "us-central1",
        Description = "Full runtime template",
        MachineSpec = new Gcp.Colab.Inputs.RuntimeTemplateMachineSpecArgs
        {
            MachineType = "n1-standard-2",
            AcceleratorType = "NVIDIA_TESLA_T4",
            AcceleratorCount = 1,
        },
        DataPersistentDiskSpec = new Gcp.Colab.Inputs.RuntimeTemplateDataPersistentDiskSpecArgs
        {
            DiskType = "pd-standard",
            DiskSizeGb = "200",
        },
        NetworkSpec = new Gcp.Colab.Inputs.RuntimeTemplateNetworkSpecArgs
        {
            EnableInternetAccess = true,
        },
        Labels = 
        {
            { "k", "val" },
        },
        IdleShutdownConfig = new Gcp.Colab.Inputs.RuntimeTemplateIdleShutdownConfigArgs
        {
            IdleTimeout = "3600s",
        },
        EucConfig = new Gcp.Colab.Inputs.RuntimeTemplateEucConfigArgs
        {
            EucDisabled = true,
        },
        ShieldedVmConfig = new Gcp.Colab.Inputs.RuntimeTemplateShieldedVmConfigArgs
        {
            EnableSecureBoot = true,
        },
        NetworkTags = new[]
        {
            "abc",
            "def",
        },
        EncryptionSpec = new Gcp.Colab.Inputs.RuntimeTemplateEncryptionSpecArgs
        {
            KmsKeyName = "my-crypto-key",
        },
    });

    var runtime = new Gcp.Colab.Runtime("runtime", new()
    {
        Name = "colab-runtime",
        Location = "us-central1",
        NotebookRuntimeTemplateRef = new Gcp.Colab.Inputs.RuntimeNotebookRuntimeTemplateRefArgs
        {
            NotebookRuntimeTemplate = myTemplate.Id,
        },
        DisplayName = "Runtime full",
        RuntimeUser = "gterraformtestuser@gmail.com",
        Description = "Full runtime",
        DesiredState = "ACTIVE",
        AutoUpgrade = true,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            myTemplate,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.colab.RuntimeTemplate;
import com.pulumi.gcp.colab.RuntimeTemplateArgs;
import com.pulumi.gcp.colab.inputs.RuntimeTemplateMachineSpecArgs;
import com.pulumi.gcp.colab.inputs.RuntimeTemplateDataPersistentDiskSpecArgs;
import com.pulumi.gcp.colab.inputs.RuntimeTemplateNetworkSpecArgs;
import com.pulumi.gcp.colab.inputs.RuntimeTemplateIdleShutdownConfigArgs;
import com.pulumi.gcp.colab.inputs.RuntimeTemplateEucConfigArgs;
import com.pulumi.gcp.colab.inputs.RuntimeTemplateShieldedVmConfigArgs;
import com.pulumi.gcp.colab.inputs.RuntimeTemplateEncryptionSpecArgs;
import com.pulumi.gcp.colab.Runtime;
import com.pulumi.gcp.colab.RuntimeArgs;
import com.pulumi.gcp.colab.inputs.RuntimeNotebookRuntimeTemplateRefArgs;
import com.pulumi.resources.CustomResourceOptions;
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 myTemplate = new RuntimeTemplate("myTemplate", RuntimeTemplateArgs.builder()
            .name("colab-runtime")
            .displayName("Runtime template full")
            .location("us-central1")
            .description("Full runtime template")
            .machineSpec(RuntimeTemplateMachineSpecArgs.builder()
                .machineType("n1-standard-2")
                .acceleratorType("NVIDIA_TESLA_T4")
                .acceleratorCount("1")
                .build())
            .dataPersistentDiskSpec(RuntimeTemplateDataPersistentDiskSpecArgs.builder()
                .diskType("pd-standard")
                .diskSizeGb(200)
                .build())
            .networkSpec(RuntimeTemplateNetworkSpecArgs.builder()
                .enableInternetAccess(true)
                .build())
            .labels(Map.of("k", "val"))
            .idleShutdownConfig(RuntimeTemplateIdleShutdownConfigArgs.builder()
                .idleTimeout("3600s")
                .build())
            .eucConfig(RuntimeTemplateEucConfigArgs.builder()
                .eucDisabled(true)
                .build())
            .shieldedVmConfig(RuntimeTemplateShieldedVmConfigArgs.builder()
                .enableSecureBoot(true)
                .build())
            .networkTags(            
                "abc",
                "def")
            .encryptionSpec(RuntimeTemplateEncryptionSpecArgs.builder()
                .kmsKeyName("my-crypto-key")
                .build())
            .build());

        var runtime = new Runtime("runtime", RuntimeArgs.builder()
            .name("colab-runtime")
            .location("us-central1")
            .notebookRuntimeTemplateRef(RuntimeNotebookRuntimeTemplateRefArgs.builder()
                .notebookRuntimeTemplate(myTemplate.id())
                .build())
            .displayName("Runtime full")
            .runtimeUser("gterraformtestuser@gmail.com")
            .description("Full runtime")
            .desiredState("ACTIVE")
            .autoUpgrade(true)
            .build(), CustomResourceOptions.builder()
                .dependsOn(myTemplate)
                .build());

    }
}

    resources:
  myTemplate:
    type: gcp:colab:RuntimeTemplate
    name: my_template
    properties:
      name: colab-runtime
      displayName: Runtime template full
      location: us-central1
      description: Full runtime template
      machineSpec:
        machineType: n1-standard-2
        acceleratorType: NVIDIA_TESLA_T4
        acceleratorCount: '1'
      dataPersistentDiskSpec:
        diskType: pd-standard
        diskSizeGb: 200
      networkSpec:
        enableInternetAccess: true
      labels:
        k: val
      idleShutdownConfig:
        idleTimeout: 3600s
      eucConfig:
        eucDisabled: true
      shieldedVmConfig:
        enableSecureBoot: true
      networkTags:
        - abc
        - def
      encryptionSpec:
        kmsKeyName: my-crypto-key
  runtime:
    type: gcp:colab:Runtime
    properties:
      name: colab-runtime
      location: us-central1
      notebookRuntimeTemplateRef:
        notebookRuntimeTemplate: ${myTemplate.id}
      displayName: Runtime full
      runtimeUser: gterraformtestuser@gmail.com
      description: Full runtime
      desiredState: ACTIVE
      autoUpgrade: true
    options:
      dependsOn:
        - ${myTemplate}

    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,
            display_name: Optional[str] = None,
            location: Optional[str] = None,
            runtime_user: Optional[str] = None,
            auto_upgrade: Optional[bool] = None,
            description: Optional[str] = None,
            desired_state: Optional[str] = None,
            name: Optional[str] = None,
            notebook_runtime_template_ref: Optional[RuntimeNotebookRuntimeTemplateRefArgs] = None,
            project: Optional[str] = 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:colab:Runtime
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RuntimeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args RuntimeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RuntimeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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.Colab.Runtime("runtimeResource", new()
{
    DisplayName = "string",
    Location = "string",
    RuntimeUser = "string",
    AutoUpgrade = false,
    Description = "string",
    DesiredState = "string",
    Name = "string",
    NotebookRuntimeTemplateRef = new Gcp.Colab.Inputs.RuntimeNotebookRuntimeTemplateRefArgs
    {
        NotebookRuntimeTemplate = "string",
    },
    Project = "string",
});

    example, err := colab.NewRuntime(ctx, "runtimeResource", &colab.RuntimeArgs{
	DisplayName:  pulumi.String("string"),
	Location:     pulumi.String("string"),
	RuntimeUser:  pulumi.String("string"),
	AutoUpgrade:  pulumi.Bool(false),
	Description:  pulumi.String("string"),
	DesiredState: pulumi.String("string"),
	Name:         pulumi.String("string"),
	NotebookRuntimeTemplateRef: &colab.RuntimeNotebookRuntimeTemplateRefArgs{
		NotebookRuntimeTemplate: pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

    var runtimeResource = new Runtime("runtimeResource", RuntimeArgs.builder()
    .displayName("string")
    .location("string")
    .runtimeUser("string")
    .autoUpgrade(false)
    .description("string")
    .desiredState("string")
    .name("string")
    .notebookRuntimeTemplateRef(RuntimeNotebookRuntimeTemplateRefArgs.builder()
        .notebookRuntimeTemplate("string")
        .build())
    .project("string")
    .build());

    runtime_resource = gcp.colab.Runtime("runtimeResource",
    display_name="string",
    location="string",
    runtime_user="string",
    auto_upgrade=False,
    description="string",
    desired_state="string",
    name="string",
    notebook_runtime_template_ref={
        "notebook_runtime_template": "string",
    },
    project="string")

    const runtimeResource = new gcp.colab.Runtime("runtimeResource", {
    displayName: "string",
    location: "string",
    runtimeUser: "string",
    autoUpgrade: false,
    description: "string",
    desiredState: "string",
    name: "string",
    notebookRuntimeTemplateRef: {
        notebookRuntimeTemplate: "string",
    },
    project: "string",
});

    type: gcp:colab:Runtime
properties:
    autoUpgrade: false
    description: string
    desiredState: string
    displayName: string
    location: string
    name: string
    notebookRuntimeTemplateRef:
        notebookRuntimeTemplate: string
    project: string
    runtimeUser: string

    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:

    DisplayName string
    Required. The display name of the Runtime.
    Location string
    The location for the resource: https://cloud.google.com/colab/docs/locations

    RuntimeUser string
    The user email of the NotebookRuntime.
    AutoUpgrade bool
    Triggers an upgrade anytime the runtime is started if it is upgradable.
    Description string
    The description of the Runtime.
    DesiredState string
    Desired state of the Colab Runtime. Set this field to RUNNING to start the runtime, and STOPPED to stop it.
    Name string
    The resource name of the Runtime
    NotebookRuntimeTemplateRef RuntimeNotebookRuntimeTemplateRef
    'Runtime specific information used for NotebookRuntime creation.' Structure is documented below.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    DisplayName string
    Required. The display name of the Runtime.
    Location string
    The location for the resource: https://cloud.google.com/colab/docs/locations

    RuntimeUser string
    The user email of the NotebookRuntime.
    AutoUpgrade bool
    Triggers an upgrade anytime the runtime is started if it is upgradable.
    Description string
    The description of the Runtime.
    DesiredState string
    Desired state of the Colab Runtime. Set this field to RUNNING to start the runtime, and STOPPED to stop it.
    Name string
    The resource name of the Runtime
    NotebookRuntimeTemplateRef RuntimeNotebookRuntimeTemplateRefArgs
    'Runtime specific information used for NotebookRuntime creation.' Structure is documented below.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    displayName String
    Required. The display name of the Runtime.
    location String
    The location for the resource: https://cloud.google.com/colab/docs/locations

    runtimeUser String
    The user email of the NotebookRuntime.
    autoUpgrade Boolean
    Triggers an upgrade anytime the runtime is started if it is upgradable.
    description String
    The description of the Runtime.
    desiredState String
    Desired state of the Colab Runtime. Set this field to RUNNING to start the runtime, and STOPPED to stop it.
    name String
    The resource name of the Runtime
    notebookRuntimeTemplateRef RuntimeNotebookRuntimeTemplateRef
    'Runtime specific information used for NotebookRuntime creation.' Structure is documented below.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    displayName string
    Required. The display name of the Runtime.
    location string
    The location for the resource: https://cloud.google.com/colab/docs/locations

    runtimeUser string
    The user email of the NotebookRuntime.
    autoUpgrade boolean
    Triggers an upgrade anytime the runtime is started if it is upgradable.
    description string
    The description of the Runtime.
    desiredState string
    Desired state of the Colab Runtime. Set this field to RUNNING to start the runtime, and STOPPED to stop it.
    name string
    The resource name of the Runtime
    notebookRuntimeTemplateRef RuntimeNotebookRuntimeTemplateRef
    'Runtime specific information used for NotebookRuntime creation.' Structure is documented below.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    display_name str
    Required. The display name of the Runtime.
    location str
    The location for the resource: https://cloud.google.com/colab/docs/locations

    runtime_user str
    The user email of the NotebookRuntime.
    auto_upgrade bool
    Triggers an upgrade anytime the runtime is started if it is upgradable.
    description str
    The description of the Runtime.
    desired_state str
    Desired state of the Colab Runtime. Set this field to RUNNING to start the runtime, and STOPPED to stop it.
    name str
    The resource name of the Runtime
    notebook_runtime_template_ref RuntimeNotebookRuntimeTemplateRefArgs
    'Runtime specific information used for NotebookRuntime creation.' Structure is documented below.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    displayName String
    Required. The display name of the Runtime.
    location String
    The location for the resource: https://cloud.google.com/colab/docs/locations

    runtimeUser String
    The user email of the NotebookRuntime.
    autoUpgrade Boolean
    Triggers an upgrade anytime the runtime is started if it is upgradable.
    description String
    The description of the Runtime.
    desiredState String
    Desired state of the Colab Runtime. Set this field to RUNNING to start the runtime, and STOPPED to stop it.
    name String
    The resource name of the Runtime
    notebookRuntimeTemplateRef Property Map
    'Runtime specific information used for NotebookRuntime creation.' Structure is documented below.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

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

    ExpirationTime string
    Output only. Timestamp when this NotebookRuntime will be expired.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsUpgradable bool
    Output only. Checks if the NotebookRuntime is upgradable.
    NotebookRuntimeType string
    Output only. The type of the notebook runtime.
    State string
    Output only. The state of the runtime.
    ExpirationTime string
    Output only. Timestamp when this NotebookRuntime will be expired.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsUpgradable bool
    Output only. Checks if the NotebookRuntime is upgradable.
    NotebookRuntimeType string
    Output only. The type of the notebook runtime.
    State string
    Output only. The state of the runtime.
    expirationTime String
    Output only. Timestamp when this NotebookRuntime will be expired.
    id String
    The provider-assigned unique ID for this managed resource.
    isUpgradable Boolean
    Output only. Checks if the NotebookRuntime is upgradable.
    notebookRuntimeType String
    Output only. The type of the notebook runtime.
    state String
    Output only. The state of the runtime.
    expirationTime string
    Output only. Timestamp when this NotebookRuntime will be expired.
    id string
    The provider-assigned unique ID for this managed resource.
    isUpgradable boolean
    Output only. Checks if the NotebookRuntime is upgradable.
    notebookRuntimeType string
    Output only. The type of the notebook runtime.
    state string
    Output only. The state of the runtime.
    expiration_time str
    Output only. Timestamp when this NotebookRuntime will be expired.
    id str
    The provider-assigned unique ID for this managed resource.
    is_upgradable bool
    Output only. Checks if the NotebookRuntime is upgradable.
    notebook_runtime_type str
    Output only. The type of the notebook runtime.
    state str
    Output only. The state of the runtime.
    expirationTime String
    Output only. Timestamp when this NotebookRuntime will be expired.
    id String
    The provider-assigned unique ID for this managed resource.
    isUpgradable Boolean
    Output only. Checks if the NotebookRuntime is upgradable.
    notebookRuntimeType String
    Output only. The type of the notebook runtime.
    state String
    Output only. The state of the 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,
        auto_upgrade: Optional[bool] = None,
        description: Optional[str] = None,
        desired_state: Optional[str] = None,
        display_name: Optional[str] = None,
        expiration_time: Optional[str] = None,
        is_upgradable: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        notebook_runtime_template_ref: Optional[RuntimeNotebookRuntimeTemplateRefArgs] = None,
        notebook_runtime_type: Optional[str] = None,
        project: Optional[str] = None,
        runtime_user: Optional[str] = None,
        state: Optional[str] = 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)
    resources:  _:    type: gcp:colab:Runtime    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoUpgrade bool
    Triggers an upgrade anytime the runtime is started if it is upgradable.
    Description string
    The description of the Runtime.
    DesiredState string
    Desired state of the Colab Runtime. Set this field to RUNNING to start the runtime, and STOPPED to stop it.
    DisplayName string
    Required. The display name of the Runtime.
    ExpirationTime string
    Output only. Timestamp when this NotebookRuntime will be expired.
    IsUpgradable bool
    Output only. Checks if the NotebookRuntime is upgradable.
    Location string
    The location for the resource: https://cloud.google.com/colab/docs/locations

    Name string
    The resource name of the Runtime
    NotebookRuntimeTemplateRef RuntimeNotebookRuntimeTemplateRef
    'Runtime specific information used for NotebookRuntime creation.' Structure is documented below.
    NotebookRuntimeType string
    Output only. The type of the notebook runtime.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    RuntimeUser string
    The user email of the NotebookRuntime.
    State string
    Output only. The state of the runtime.
    AutoUpgrade bool
    Triggers an upgrade anytime the runtime is started if it is upgradable.
    Description string
    The description of the Runtime.
    DesiredState string
    Desired state of the Colab Runtime. Set this field to RUNNING to start the runtime, and STOPPED to stop it.
    DisplayName string
    Required. The display name of the Runtime.
    ExpirationTime string
    Output only. Timestamp when this NotebookRuntime will be expired.
    IsUpgradable bool
    Output only. Checks if the NotebookRuntime is upgradable.
    Location string
    The location for the resource: https://cloud.google.com/colab/docs/locations

    Name string
    The resource name of the Runtime
    NotebookRuntimeTemplateRef RuntimeNotebookRuntimeTemplateRefArgs
    'Runtime specific information used for NotebookRuntime creation.' Structure is documented below.
    NotebookRuntimeType string
    Output only. The type of the notebook runtime.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    RuntimeUser string
    The user email of the NotebookRuntime.
    State string
    Output only. The state of the runtime.
    autoUpgrade Boolean
    Triggers an upgrade anytime the runtime is started if it is upgradable.
    description String
    The description of the Runtime.
    desiredState String
    Desired state of the Colab Runtime. Set this field to RUNNING to start the runtime, and STOPPED to stop it.
    displayName String
    Required. The display name of the Runtime.
    expirationTime String
    Output only. Timestamp when this NotebookRuntime will be expired.
    isUpgradable Boolean
    Output only. Checks if the NotebookRuntime is upgradable.
    location String
    The location for the resource: https://cloud.google.com/colab/docs/locations

    name String
    The resource name of the Runtime
    notebookRuntimeTemplateRef RuntimeNotebookRuntimeTemplateRef
    'Runtime specific information used for NotebookRuntime creation.' Structure is documented below.
    notebookRuntimeType String
    Output only. The type of the notebook runtime.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    runtimeUser String
    The user email of the NotebookRuntime.
    state String
    Output only. The state of the runtime.
    autoUpgrade boolean
    Triggers an upgrade anytime the runtime is started if it is upgradable.
    description string
    The description of the Runtime.
    desiredState string
    Desired state of the Colab Runtime. Set this field to RUNNING to start the runtime, and STOPPED to stop it.
    displayName string
    Required. The display name of the Runtime.
    expirationTime string
    Output only. Timestamp when this NotebookRuntime will be expired.
    isUpgradable boolean
    Output only. Checks if the NotebookRuntime is upgradable.
    location string
    The location for the resource: https://cloud.google.com/colab/docs/locations

    name string
    The resource name of the Runtime
    notebookRuntimeTemplateRef RuntimeNotebookRuntimeTemplateRef
    'Runtime specific information used for NotebookRuntime creation.' Structure is documented below.
    notebookRuntimeType string
    Output only. The type of the notebook runtime.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    runtimeUser string
    The user email of the NotebookRuntime.
    state string
    Output only. The state of the runtime.
    auto_upgrade bool
    Triggers an upgrade anytime the runtime is started if it is upgradable.
    description str
    The description of the Runtime.
    desired_state str
    Desired state of the Colab Runtime. Set this field to RUNNING to start the runtime, and STOPPED to stop it.
    display_name str
    Required. The display name of the Runtime.
    expiration_time str
    Output only. Timestamp when this NotebookRuntime will be expired.
    is_upgradable bool
    Output only. Checks if the NotebookRuntime is upgradable.
    location str
    The location for the resource: https://cloud.google.com/colab/docs/locations

    name str
    The resource name of the Runtime
    notebook_runtime_template_ref RuntimeNotebookRuntimeTemplateRefArgs
    'Runtime specific information used for NotebookRuntime creation.' Structure is documented below.
    notebook_runtime_type str
    Output only. The type of the notebook runtime.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    runtime_user str
    The user email of the NotebookRuntime.
    state str
    Output only. The state of the runtime.
    autoUpgrade Boolean
    Triggers an upgrade anytime the runtime is started if it is upgradable.
    description String
    The description of the Runtime.
    desiredState String
    Desired state of the Colab Runtime. Set this field to RUNNING to start the runtime, and STOPPED to stop it.
    displayName String
    Required. The display name of the Runtime.
    expirationTime String
    Output only. Timestamp when this NotebookRuntime will be expired.
    isUpgradable Boolean
    Output only. Checks if the NotebookRuntime is upgradable.
    location String
    The location for the resource: https://cloud.google.com/colab/docs/locations

    name String
    The resource name of the Runtime
    notebookRuntimeTemplateRef Property Map
    'Runtime specific information used for NotebookRuntime creation.' Structure is documented below.
    notebookRuntimeType String
    Output only. The type of the notebook runtime.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    runtimeUser String
    The user email of the NotebookRuntime.
    state String
    Output only. The state of the runtime.

    Supporting Types

    RuntimeNotebookRuntimeTemplateRef, RuntimeNotebookRuntimeTemplateRefArgs

    NotebookRuntimeTemplate string
    The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be created.
    NotebookRuntimeTemplate string
    The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be created.
    notebookRuntimeTemplate String
    The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be created.
    notebookRuntimeTemplate string
    The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be created.
    notebook_runtime_template str
    The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be created.
    notebookRuntimeTemplate String
    The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be created.

    Import

    Runtime can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/notebookRuntimes/{{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:colab/runtime:Runtime default projects/{{project}}/locations/{{location}}/notebookRuntimes/{{name}}

    $ pulumi import gcp:colab/runtime:Runtime default {{project}}/{{location}}/{{name}}

    $ pulumi import gcp:colab/runtime:Runtime default {{location}}/{{name}}

    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.
    gcp logo
    Google Cloud v8.22.0 published on Thursday, Mar 13, 2025 by Pulumi
    pulumi/pulumi-gcp