Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. notebooks
  5. Instance
Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.notebooks.Instance

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-gcp

    Warning: google_notebook_instance is deprecated and will be removed in a future major release. Use gcp.workbench.Instance instead.

    A Cloud AI Platform Notebook instance.

    Note: Due to limitations of the Notebooks Instance 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 Instance, see:

    Example Usage

    Notebook Instance Basic

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

const instance = new gcp.notebooks.Instance("instance", {
    name: "notebooks-instance",
    location: "us-west1-a",
    machineType: "e2-medium",
    vmImage: {
        project: "deeplearning-platform-release",
        imageFamily: "tf-latest-cpu",
    },
});

    import pulumi
import pulumi_gcp as gcp

instance = gcp.notebooks.Instance("instance",
    name="notebooks-instance",
    location="us-west1-a",
    machine_type="e2-medium",
    vm_image=gcp.notebooks.InstanceVmImageArgs(
        project="deeplearning-platform-release",
        image_family="tf-latest-cpu",
    ))

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := notebooks.NewInstance(ctx, "instance", &notebooks.InstanceArgs{
			Name:        pulumi.String("notebooks-instance"),
			Location:    pulumi.String("us-west1-a"),
			MachineType: pulumi.String("e2-medium"),
			VmImage: &notebooks.InstanceVmImageArgs{
				Project:     pulumi.String("deeplearning-platform-release"),
				ImageFamily: pulumi.String("tf-latest-cpu"),
			},
		})
		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 instance = new Gcp.Notebooks.Instance("instance", new()
    {
        Name = "notebooks-instance",
        Location = "us-west1-a",
        MachineType = "e2-medium",
        VmImage = new Gcp.Notebooks.Inputs.InstanceVmImageArgs
        {
            Project = "deeplearning-platform-release",
            ImageFamily = "tf-latest-cpu",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.Instance;
import com.pulumi.gcp.notebooks.InstanceArgs;
import com.pulumi.gcp.notebooks.inputs.InstanceVmImageArgs;
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 instance = new Instance("instance", InstanceArgs.builder()
            .name("notebooks-instance")
            .location("us-west1-a")
            .machineType("e2-medium")
            .vmImage(InstanceVmImageArgs.builder()
                .project("deeplearning-platform-release")
                .imageFamily("tf-latest-cpu")
                .build())
            .build());

    }
}

    resources:
  instance:
    type: gcp:notebooks:Instance
    properties:
      name: notebooks-instance
      location: us-west1-a
      machineType: e2-medium
      vmImage:
        project: deeplearning-platform-release
        imageFamily: tf-latest-cpu

    Notebook Instance Basic Stopped

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

const instance = new gcp.notebooks.Instance("instance", {
    name: "notebooks-instance",
    location: "us-west1-a",
    machineType: "e2-medium",
    vmImage: {
        project: "deeplearning-platform-release",
        imageFamily: "tf-latest-cpu",
    },
    desiredState: "STOPPED",
});

    import pulumi
import pulumi_gcp as gcp

instance = gcp.notebooks.Instance("instance",
    name="notebooks-instance",
    location="us-west1-a",
    machine_type="e2-medium",
    vm_image=gcp.notebooks.InstanceVmImageArgs(
        project="deeplearning-platform-release",
        image_family="tf-latest-cpu",
    ),
    desired_state="STOPPED")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := notebooks.NewInstance(ctx, "instance", &notebooks.InstanceArgs{
			Name:        pulumi.String("notebooks-instance"),
			Location:    pulumi.String("us-west1-a"),
			MachineType: pulumi.String("e2-medium"),
			VmImage: &notebooks.InstanceVmImageArgs{
				Project:     pulumi.String("deeplearning-platform-release"),
				ImageFamily: pulumi.String("tf-latest-cpu"),
			},
			DesiredState: pulumi.String("STOPPED"),
		})
		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 instance = new Gcp.Notebooks.Instance("instance", new()
    {
        Name = "notebooks-instance",
        Location = "us-west1-a",
        MachineType = "e2-medium",
        VmImage = new Gcp.Notebooks.Inputs.InstanceVmImageArgs
        {
            Project = "deeplearning-platform-release",
            ImageFamily = "tf-latest-cpu",
        },
        DesiredState = "STOPPED",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.Instance;
import com.pulumi.gcp.notebooks.InstanceArgs;
import com.pulumi.gcp.notebooks.inputs.InstanceVmImageArgs;
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 instance = new Instance("instance", InstanceArgs.builder()
            .name("notebooks-instance")
            .location("us-west1-a")
            .machineType("e2-medium")
            .vmImage(InstanceVmImageArgs.builder()
                .project("deeplearning-platform-release")
                .imageFamily("tf-latest-cpu")
                .build())
            .desiredState("STOPPED")
            .build());

    }
}

    resources:
  instance:
    type: gcp:notebooks:Instance
    properties:
      name: notebooks-instance
      location: us-west1-a
      machineType: e2-medium
      vmImage:
        project: deeplearning-platform-release
        imageFamily: tf-latest-cpu
      desiredState: STOPPED

    Notebook Instance Basic Container

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

const instance = new gcp.notebooks.Instance("instance", {
    name: "notebooks-instance",
    location: "us-west1-a",
    machineType: "e2-medium",
    metadata: {
        "proxy-mode": "service_account",
    },
    containerImage: {
        repository: "gcr.io/deeplearning-platform-release/base-cpu",
        tag: "latest",
    },
});

    import pulumi
import pulumi_gcp as gcp

instance = gcp.notebooks.Instance("instance",
    name="notebooks-instance",
    location="us-west1-a",
    machine_type="e2-medium",
    metadata={
        "proxy-mode": "service_account",
    },
    container_image=gcp.notebooks.InstanceContainerImageArgs(
        repository="gcr.io/deeplearning-platform-release/base-cpu",
        tag="latest",
    ))

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := notebooks.NewInstance(ctx, "instance", &notebooks.InstanceArgs{
			Name:        pulumi.String("notebooks-instance"),
			Location:    pulumi.String("us-west1-a"),
			MachineType: pulumi.String("e2-medium"),
			Metadata: pulumi.StringMap{
				"proxy-mode": pulumi.String("service_account"),
			},
			ContainerImage: &notebooks.InstanceContainerImageArgs{
				Repository: pulumi.String("gcr.io/deeplearning-platform-release/base-cpu"),
				Tag:        pulumi.String("latest"),
			},
		})
		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 instance = new Gcp.Notebooks.Instance("instance", new()
    {
        Name = "notebooks-instance",
        Location = "us-west1-a",
        MachineType = "e2-medium",
        Metadata = 
        {
            { "proxy-mode", "service_account" },
        },
        ContainerImage = new Gcp.Notebooks.Inputs.InstanceContainerImageArgs
        {
            Repository = "gcr.io/deeplearning-platform-release/base-cpu",
            Tag = "latest",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.Instance;
import com.pulumi.gcp.notebooks.InstanceArgs;
import com.pulumi.gcp.notebooks.inputs.InstanceContainerImageArgs;
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 instance = new Instance("instance", InstanceArgs.builder()
            .name("notebooks-instance")
            .location("us-west1-a")
            .machineType("e2-medium")
            .metadata(Map.of("proxy-mode", "service_account"))
            .containerImage(InstanceContainerImageArgs.builder()
                .repository("gcr.io/deeplearning-platform-release/base-cpu")
                .tag("latest")
                .build())
            .build());

    }
}

    resources:
  instance:
    type: gcp:notebooks:Instance
    properties:
      name: notebooks-instance
      location: us-west1-a
      machineType: e2-medium
      metadata:
        proxy-mode: service_account
      containerImage:
        repository: gcr.io/deeplearning-platform-release/base-cpu
        tag: latest

    Notebook Instance Basic Gpu

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

const instance = new gcp.notebooks.Instance("instance", {
    name: "notebooks-instance",
    location: "us-west1-a",
    machineType: "n1-standard-1",
    installGpuDriver: true,
    acceleratorConfig: {
        type: "NVIDIA_TESLA_T4",
        coreCount: 1,
    },
    vmImage: {
        project: "deeplearning-platform-release",
        imageFamily: "tf-latest-gpu",
    },
});

    import pulumi
import pulumi_gcp as gcp

instance = gcp.notebooks.Instance("instance",
    name="notebooks-instance",
    location="us-west1-a",
    machine_type="n1-standard-1",
    install_gpu_driver=True,
    accelerator_config=gcp.notebooks.InstanceAcceleratorConfigArgs(
        type="NVIDIA_TESLA_T4",
        core_count=1,
    ),
    vm_image=gcp.notebooks.InstanceVmImageArgs(
        project="deeplearning-platform-release",
        image_family="tf-latest-gpu",
    ))

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := notebooks.NewInstance(ctx, "instance", &notebooks.InstanceArgs{
			Name:             pulumi.String("notebooks-instance"),
			Location:         pulumi.String("us-west1-a"),
			MachineType:      pulumi.String("n1-standard-1"),
			InstallGpuDriver: pulumi.Bool(true),
			AcceleratorConfig: &notebooks.InstanceAcceleratorConfigArgs{
				Type:      pulumi.String("NVIDIA_TESLA_T4"),
				CoreCount: pulumi.Int(1),
			},
			VmImage: &notebooks.InstanceVmImageArgs{
				Project:     pulumi.String("deeplearning-platform-release"),
				ImageFamily: pulumi.String("tf-latest-gpu"),
			},
		})
		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 instance = new Gcp.Notebooks.Instance("instance", new()
    {
        Name = "notebooks-instance",
        Location = "us-west1-a",
        MachineType = "n1-standard-1",
        InstallGpuDriver = true,
        AcceleratorConfig = new Gcp.Notebooks.Inputs.InstanceAcceleratorConfigArgs
        {
            Type = "NVIDIA_TESLA_T4",
            CoreCount = 1,
        },
        VmImage = new Gcp.Notebooks.Inputs.InstanceVmImageArgs
        {
            Project = "deeplearning-platform-release",
            ImageFamily = "tf-latest-gpu",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.Instance;
import com.pulumi.gcp.notebooks.InstanceArgs;
import com.pulumi.gcp.notebooks.inputs.InstanceAcceleratorConfigArgs;
import com.pulumi.gcp.notebooks.inputs.InstanceVmImageArgs;
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 instance = new Instance("instance", InstanceArgs.builder()
            .name("notebooks-instance")
            .location("us-west1-a")
            .machineType("n1-standard-1")
            .installGpuDriver(true)
            .acceleratorConfig(InstanceAcceleratorConfigArgs.builder()
                .type("NVIDIA_TESLA_T4")
                .coreCount(1)
                .build())
            .vmImage(InstanceVmImageArgs.builder()
                .project("deeplearning-platform-release")
                .imageFamily("tf-latest-gpu")
                .build())
            .build());

    }
}

    resources:
  instance:
    type: gcp:notebooks:Instance
    properties:
      name: notebooks-instance
      location: us-west1-a
      machineType: n1-standard-1
      installGpuDriver: true
      acceleratorConfig:
        type: NVIDIA_TESLA_T4
        coreCount: 1
      vmImage:
        project: deeplearning-platform-release
        imageFamily: tf-latest-gpu

    Notebook Instance Full

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

const myNetwork = gcp.compute.getNetwork({
    name: "default",
});
const mySubnetwork = gcp.compute.getSubnetwork({
    name: "default",
    region: "us-central1",
});
const instance = new gcp.notebooks.Instance("instance", {
    name: "notebooks-instance",
    location: "us-central1-a",
    machineType: "e2-medium",
    vmImage: {
        project: "deeplearning-platform-release",
        imageFamily: "tf-latest-cpu",
    },
    instanceOwners: ["my@service-account.com"],
    serviceAccount: "my@service-account.com",
    installGpuDriver: true,
    bootDiskType: "PD_SSD",
    bootDiskSizeGb: 110,
    noPublicIp: true,
    noProxyAccess: true,
    network: myNetwork.then(myNetwork => myNetwork.id),
    subnet: mySubnetwork.then(mySubnetwork => mySubnetwork.id),
    labels: {
        k: "val",
    },
    metadata: {
        terraform: "true",
    },
    serviceAccountScopes: [
        "https://www.googleapis.com/auth/bigquery",
        "https://www.googleapis.com/auth/devstorage.read_write",
        "https://www.googleapis.com/auth/cloud-platform",
        "https://www.googleapis.com/auth/userinfo.email",
    ],
    tags: [
        "foo",
        "bar",
    ],
    diskEncryption: "CMEK",
    kmsKey: "my-crypto-key",
    desiredState: "ACTIVE",
});

    import pulumi
import pulumi_gcp as gcp

my_network = gcp.compute.get_network(name="default")
my_subnetwork = gcp.compute.get_subnetwork(name="default",
    region="us-central1")
instance = gcp.notebooks.Instance("instance",
    name="notebooks-instance",
    location="us-central1-a",
    machine_type="e2-medium",
    vm_image=gcp.notebooks.InstanceVmImageArgs(
        project="deeplearning-platform-release",
        image_family="tf-latest-cpu",
    ),
    instance_owners=["my@service-account.com"],
    service_account="my@service-account.com",
    install_gpu_driver=True,
    boot_disk_type="PD_SSD",
    boot_disk_size_gb=110,
    no_public_ip=True,
    no_proxy_access=True,
    network=my_network.id,
    subnet=my_subnetwork.id,
    labels={
        "k": "val",
    },
    metadata={
        "terraform": "true",
    },
    service_account_scopes=[
        "https://www.googleapis.com/auth/bigquery",
        "https://www.googleapis.com/auth/devstorage.read_write",
        "https://www.googleapis.com/auth/cloud-platform",
        "https://www.googleapis.com/auth/userinfo.email",
    ],
    tags=[
        "foo",
        "bar",
    ],
    disk_encryption="CMEK",
    kms_key="my-crypto-key",
    desired_state="ACTIVE")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myNetwork, err := compute.LookupNetwork(ctx, &compute.LookupNetworkArgs{
			Name: "default",
		}, nil)
		if err != nil {
			return err
		}
		mySubnetwork, err := compute.LookupSubnetwork(ctx, &compute.LookupSubnetworkArgs{
			Name:   pulumi.StringRef("default"),
			Region: pulumi.StringRef("us-central1"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = notebooks.NewInstance(ctx, "instance", &notebooks.InstanceArgs{
			Name:        pulumi.String("notebooks-instance"),
			Location:    pulumi.String("us-central1-a"),
			MachineType: pulumi.String("e2-medium"),
			VmImage: &notebooks.InstanceVmImageArgs{
				Project:     pulumi.String("deeplearning-platform-release"),
				ImageFamily: pulumi.String("tf-latest-cpu"),
			},
			InstanceOwners: pulumi.StringArray{
				pulumi.String("my@service-account.com"),
			},
			ServiceAccount:   pulumi.String("my@service-account.com"),
			InstallGpuDriver: pulumi.Bool(true),
			BootDiskType:     pulumi.String("PD_SSD"),
			BootDiskSizeGb:   pulumi.Int(110),
			NoPublicIp:       pulumi.Bool(true),
			NoProxyAccess:    pulumi.Bool(true),
			Network:          pulumi.String(myNetwork.Id),
			Subnet:           pulumi.String(mySubnetwork.Id),
			Labels: pulumi.StringMap{
				"k": pulumi.String("val"),
			},
			Metadata: pulumi.StringMap{
				"terraform": pulumi.String("true"),
			},
			ServiceAccountScopes: pulumi.StringArray{
				pulumi.String("https://www.googleapis.com/auth/bigquery"),
				pulumi.String("https://www.googleapis.com/auth/devstorage.read_write"),
				pulumi.String("https://www.googleapis.com/auth/cloud-platform"),
				pulumi.String("https://www.googleapis.com/auth/userinfo.email"),
			},
			Tags: pulumi.StringArray{
				pulumi.String("foo"),
				pulumi.String("bar"),
			},
			DiskEncryption: pulumi.String("CMEK"),
			KmsKey:         pulumi.String("my-crypto-key"),
			DesiredState:   pulumi.String("ACTIVE"),
		})
		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 myNetwork = Gcp.Compute.GetNetwork.Invoke(new()
    {
        Name = "default",
    });

    var mySubnetwork = Gcp.Compute.GetSubnetwork.Invoke(new()
    {
        Name = "default",
        Region = "us-central1",
    });

    var instance = new Gcp.Notebooks.Instance("instance", new()
    {
        Name = "notebooks-instance",
        Location = "us-central1-a",
        MachineType = "e2-medium",
        VmImage = new Gcp.Notebooks.Inputs.InstanceVmImageArgs
        {
            Project = "deeplearning-platform-release",
            ImageFamily = "tf-latest-cpu",
        },
        InstanceOwners = new[]
        {
            "my@service-account.com",
        },
        ServiceAccount = "my@service-account.com",
        InstallGpuDriver = true,
        BootDiskType = "PD_SSD",
        BootDiskSizeGb = 110,
        NoPublicIp = true,
        NoProxyAccess = true,
        Network = myNetwork.Apply(getNetworkResult => getNetworkResult.Id),
        Subnet = mySubnetwork.Apply(getSubnetworkResult => getSubnetworkResult.Id),
        Labels = 
        {
            { "k", "val" },
        },
        Metadata = 
        {
            { "terraform", "true" },
        },
        ServiceAccountScopes = new[]
        {
            "https://www.googleapis.com/auth/bigquery",
            "https://www.googleapis.com/auth/devstorage.read_write",
            "https://www.googleapis.com/auth/cloud-platform",
            "https://www.googleapis.com/auth/userinfo.email",
        },
        Tags = new[]
        {
            "foo",
            "bar",
        },
        DiskEncryption = "CMEK",
        KmsKey = "my-crypto-key",
        DesiredState = "ACTIVE",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetNetworkArgs;
import com.pulumi.gcp.compute.inputs.GetSubnetworkArgs;
import com.pulumi.gcp.notebooks.Instance;
import com.pulumi.gcp.notebooks.InstanceArgs;
import com.pulumi.gcp.notebooks.inputs.InstanceVmImageArgs;
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) {
        final var myNetwork = ComputeFunctions.getNetwork(GetNetworkArgs.builder()
            .name("default")
            .build());

        final var mySubnetwork = ComputeFunctions.getSubnetwork(GetSubnetworkArgs.builder()
            .name("default")
            .region("us-central1")
            .build());

        var instance = new Instance("instance", InstanceArgs.builder()
            .name("notebooks-instance")
            .location("us-central1-a")
            .machineType("e2-medium")
            .vmImage(InstanceVmImageArgs.builder()
                .project("deeplearning-platform-release")
                .imageFamily("tf-latest-cpu")
                .build())
            .instanceOwners("my@service-account.com")
            .serviceAccount("my@service-account.com")
            .installGpuDriver(true)
            .bootDiskType("PD_SSD")
            .bootDiskSizeGb(110)
            .noPublicIp(true)
            .noProxyAccess(true)
            .network(myNetwork.applyValue(getNetworkResult -> getNetworkResult.id()))
            .subnet(mySubnetwork.applyValue(getSubnetworkResult -> getSubnetworkResult.id()))
            .labels(Map.of("k", "val"))
            .metadata(Map.of("terraform", "true"))
            .serviceAccountScopes(            
                "https://www.googleapis.com/auth/bigquery",
                "https://www.googleapis.com/auth/devstorage.read_write",
                "https://www.googleapis.com/auth/cloud-platform",
                "https://www.googleapis.com/auth/userinfo.email")
            .tags(            
                "foo",
                "bar")
            .diskEncryption("CMEK")
            .kmsKey("my-crypto-key")
            .desiredState("ACTIVE")
            .build());

    }
}

    resources:
  instance:
    type: gcp:notebooks:Instance
    properties:
      name: notebooks-instance
      location: us-central1-a
      machineType: e2-medium
      vmImage:
        project: deeplearning-platform-release
        imageFamily: tf-latest-cpu
      instanceOwners:
        - my@service-account.com
      serviceAccount: my@service-account.com
      installGpuDriver: true
      bootDiskType: PD_SSD
      bootDiskSizeGb: 110
      noPublicIp: true
      noProxyAccess: true
      network: ${myNetwork.id}
      subnet: ${mySubnetwork.id}
      labels:
        k: val
      metadata:
        terraform: 'true'
      serviceAccountScopes:
        - https://www.googleapis.com/auth/bigquery
        - https://www.googleapis.com/auth/devstorage.read_write
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/userinfo.email
      tags:
        - foo
        - bar
      diskEncryption: CMEK
      kmsKey: my-crypto-key
      desiredState: ACTIVE
variables:
  myNetwork:
    fn::invoke:
      Function: gcp:compute:getNetwork
      Arguments:
        name: default
  mySubnetwork:
    fn::invoke:
      Function: gcp:compute:getSubnetwork
      Arguments:
        name: default
        region: us-central1

    Create Instance Resource

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

    Constructor syntax

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

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             location: Optional[str] = None,
             machine_type: Optional[str] = None,
             metadata: Optional[Mapping[str, str]] = None,
             vm_image: Optional[InstanceVmImageArgs] = None,
             accelerator_config: Optional[InstanceAcceleratorConfigArgs] = None,
             custom_gpu_driver_path: Optional[str] = None,
             data_disk_size_gb: Optional[int] = None,
             data_disk_type: Optional[str] = None,
             desired_state: Optional[str] = None,
             disk_encryption: Optional[str] = None,
             install_gpu_driver: Optional[bool] = None,
             instance_owners: Optional[Sequence[str]] = None,
             kms_key: Optional[str] = None,
             labels: Optional[Mapping[str, str]] = None,
             boot_disk_type: Optional[str] = None,
             boot_disk_size_gb: Optional[int] = None,
             create_time: Optional[str] = None,
             network: Optional[str] = None,
             container_image: Optional[InstanceContainerImageArgs] = None,
             nic_type: Optional[str] = None,
             no_proxy_access: Optional[bool] = None,
             no_public_ip: Optional[bool] = None,
             no_remove_data_disk: Optional[bool] = None,
             post_startup_script: Optional[str] = None,
             project: Optional[str] = None,
             reservation_affinity: Optional[InstanceReservationAffinityArgs] = None,
             service_account: Optional[str] = None,
             service_account_scopes: Optional[Sequence[str]] = None,
             shielded_instance_config: Optional[InstanceShieldedInstanceConfigArgs] = None,
             subnet: Optional[str] = None,
             tags: Optional[Sequence[str]] = None,
             update_time: Optional[str] = None,
             name: Optional[str] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: gcp:notebooks:Instance
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 InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    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 InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    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 exampleinstanceResourceResourceFromNotebooksinstance = new Gcp.Notebooks.Instance("exampleinstanceResourceResourceFromNotebooksinstance", new()
{
    Location = "string",
    MachineType = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    VmImage = new Gcp.Notebooks.Inputs.InstanceVmImageArgs
    {
        Project = "string",
        ImageFamily = "string",
        ImageName = "string",
    },
    AcceleratorConfig = new Gcp.Notebooks.Inputs.InstanceAcceleratorConfigArgs
    {
        CoreCount = 0,
        Type = "string",
    },
    CustomGpuDriverPath = "string",
    DataDiskSizeGb = 0,
    DataDiskType = "string",
    DesiredState = "string",
    DiskEncryption = "string",
    InstallGpuDriver = false,
    InstanceOwners = new[]
    {
        "string",
    },
    KmsKey = "string",
    Labels = 
    {
        { "string", "string" },
    },
    BootDiskType = "string",
    BootDiskSizeGb = 0,
    CreateTime = "string",
    Network = "string",
    ContainerImage = new Gcp.Notebooks.Inputs.InstanceContainerImageArgs
    {
        Repository = "string",
        Tag = "string",
    },
    NicType = "string",
    NoProxyAccess = false,
    NoPublicIp = false,
    NoRemoveDataDisk = false,
    PostStartupScript = "string",
    Project = "string",
    ReservationAffinity = new Gcp.Notebooks.Inputs.InstanceReservationAffinityArgs
    {
        ConsumeReservationType = "string",
        Key = "string",
        Values = new[]
        {
            "string",
        },
    },
    ServiceAccount = "string",
    ServiceAccountScopes = new[]
    {
        "string",
    },
    ShieldedInstanceConfig = new Gcp.Notebooks.Inputs.InstanceShieldedInstanceConfigArgs
    {
        EnableIntegrityMonitoring = false,
        EnableSecureBoot = false,
        EnableVtpm = false,
    },
    Subnet = "string",
    Tags = new[]
    {
        "string",
    },
    UpdateTime = "string",
    Name = "string",
});

    example, err := notebooks.NewInstance(ctx, "exampleinstanceResourceResourceFromNotebooksinstance", &notebooks.InstanceArgs{
	Location:    pulumi.String("string"),
	MachineType: pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VmImage: &notebooks.InstanceVmImageArgs{
		Project:     pulumi.String("string"),
		ImageFamily: pulumi.String("string"),
		ImageName:   pulumi.String("string"),
	},
	AcceleratorConfig: &notebooks.InstanceAcceleratorConfigArgs{
		CoreCount: pulumi.Int(0),
		Type:      pulumi.String("string"),
	},
	CustomGpuDriverPath: pulumi.String("string"),
	DataDiskSizeGb:      pulumi.Int(0),
	DataDiskType:        pulumi.String("string"),
	DesiredState:        pulumi.String("string"),
	DiskEncryption:      pulumi.String("string"),
	InstallGpuDriver:    pulumi.Bool(false),
	InstanceOwners: pulumi.StringArray{
		pulumi.String("string"),
	},
	KmsKey: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	BootDiskType:   pulumi.String("string"),
	BootDiskSizeGb: pulumi.Int(0),
	CreateTime:     pulumi.String("string"),
	Network:        pulumi.String("string"),
	ContainerImage: &notebooks.InstanceContainerImageArgs{
		Repository: pulumi.String("string"),
		Tag:        pulumi.String("string"),
	},
	NicType:           pulumi.String("string"),
	NoProxyAccess:     pulumi.Bool(false),
	NoPublicIp:        pulumi.Bool(false),
	NoRemoveDataDisk:  pulumi.Bool(false),
	PostStartupScript: pulumi.String("string"),
	Project:           pulumi.String("string"),
	ReservationAffinity: &notebooks.InstanceReservationAffinityArgs{
		ConsumeReservationType: pulumi.String("string"),
		Key:                    pulumi.String("string"),
		Values: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ServiceAccount: pulumi.String("string"),
	ServiceAccountScopes: pulumi.StringArray{
		pulumi.String("string"),
	},
	ShieldedInstanceConfig: &notebooks.InstanceShieldedInstanceConfigArgs{
		EnableIntegrityMonitoring: pulumi.Bool(false),
		EnableSecureBoot:          pulumi.Bool(false),
		EnableVtpm:                pulumi.Bool(false),
	},
	Subnet: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	UpdateTime: pulumi.String("string"),
	Name:       pulumi.String("string"),
})

    var exampleinstanceResourceResourceFromNotebooksinstance = new Instance("exampleinstanceResourceResourceFromNotebooksinstance", InstanceArgs.builder()
    .location("string")
    .machineType("string")
    .metadata(Map.of("string", "string"))
    .vmImage(InstanceVmImageArgs.builder()
        .project("string")
        .imageFamily("string")
        .imageName("string")
        .build())
    .acceleratorConfig(InstanceAcceleratorConfigArgs.builder()
        .coreCount(0)
        .type("string")
        .build())
    .customGpuDriverPath("string")
    .dataDiskSizeGb(0)
    .dataDiskType("string")
    .desiredState("string")
    .diskEncryption("string")
    .installGpuDriver(false)
    .instanceOwners("string")
    .kmsKey("string")
    .labels(Map.of("string", "string"))
    .bootDiskType("string")
    .bootDiskSizeGb(0)
    .createTime("string")
    .network("string")
    .containerImage(InstanceContainerImageArgs.builder()
        .repository("string")
        .tag("string")
        .build())
    .nicType("string")
    .noProxyAccess(false)
    .noPublicIp(false)
    .noRemoveDataDisk(false)
    .postStartupScript("string")
    .project("string")
    .reservationAffinity(InstanceReservationAffinityArgs.builder()
        .consumeReservationType("string")
        .key("string")
        .values("string")
        .build())
    .serviceAccount("string")
    .serviceAccountScopes("string")
    .shieldedInstanceConfig(InstanceShieldedInstanceConfigArgs.builder()
        .enableIntegrityMonitoring(false)
        .enableSecureBoot(false)
        .enableVtpm(false)
        .build())
    .subnet("string")
    .tags("string")
    .updateTime("string")
    .name("string")
    .build());

    exampleinstance_resource_resource_from_notebooksinstance = gcp.notebooks.Instance("exampleinstanceResourceResourceFromNotebooksinstance",
    location="string",
    machine_type="string",
    metadata={
        "string": "string",
    },
    vm_image=gcp.notebooks.InstanceVmImageArgs(
        project="string",
        image_family="string",
        image_name="string",
    ),
    accelerator_config=gcp.notebooks.InstanceAcceleratorConfigArgs(
        core_count=0,
        type="string",
    ),
    custom_gpu_driver_path="string",
    data_disk_size_gb=0,
    data_disk_type="string",
    desired_state="string",
    disk_encryption="string",
    install_gpu_driver=False,
    instance_owners=["string"],
    kms_key="string",
    labels={
        "string": "string",
    },
    boot_disk_type="string",
    boot_disk_size_gb=0,
    create_time="string",
    network="string",
    container_image=gcp.notebooks.InstanceContainerImageArgs(
        repository="string",
        tag="string",
    ),
    nic_type="string",
    no_proxy_access=False,
    no_public_ip=False,
    no_remove_data_disk=False,
    post_startup_script="string",
    project="string",
    reservation_affinity=gcp.notebooks.InstanceReservationAffinityArgs(
        consume_reservation_type="string",
        key="string",
        values=["string"],
    ),
    service_account="string",
    service_account_scopes=["string"],
    shielded_instance_config=gcp.notebooks.InstanceShieldedInstanceConfigArgs(
        enable_integrity_monitoring=False,
        enable_secure_boot=False,
        enable_vtpm=False,
    ),
    subnet="string",
    tags=["string"],
    update_time="string",
    name="string")

    const exampleinstanceResourceResourceFromNotebooksinstance = new gcp.notebooks.Instance("exampleinstanceResourceResourceFromNotebooksinstance", {
    location: "string",
    machineType: "string",
    metadata: {
        string: "string",
    },
    vmImage: {
        project: "string",
        imageFamily: "string",
        imageName: "string",
    },
    acceleratorConfig: {
        coreCount: 0,
        type: "string",
    },
    customGpuDriverPath: "string",
    dataDiskSizeGb: 0,
    dataDiskType: "string",
    desiredState: "string",
    diskEncryption: "string",
    installGpuDriver: false,
    instanceOwners: ["string"],
    kmsKey: "string",
    labels: {
        string: "string",
    },
    bootDiskType: "string",
    bootDiskSizeGb: 0,
    createTime: "string",
    network: "string",
    containerImage: {
        repository: "string",
        tag: "string",
    },
    nicType: "string",
    noProxyAccess: false,
    noPublicIp: false,
    noRemoveDataDisk: false,
    postStartupScript: "string",
    project: "string",
    reservationAffinity: {
        consumeReservationType: "string",
        key: "string",
        values: ["string"],
    },
    serviceAccount: "string",
    serviceAccountScopes: ["string"],
    shieldedInstanceConfig: {
        enableIntegrityMonitoring: false,
        enableSecureBoot: false,
        enableVtpm: false,
    },
    subnet: "string",
    tags: ["string"],
    updateTime: "string",
    name: "string",
});

    type: gcp:notebooks:Instance
properties:
    acceleratorConfig:
        coreCount: 0
        type: string
    bootDiskSizeGb: 0
    bootDiskType: string
    containerImage:
        repository: string
        tag: string
    createTime: string
    customGpuDriverPath: string
    dataDiskSizeGb: 0
    dataDiskType: string
    desiredState: string
    diskEncryption: string
    installGpuDriver: false
    instanceOwners:
        - string
    kmsKey: string
    labels:
        string: string
    location: string
    machineType: string
    metadata:
        string: string
    name: string
    network: string
    nicType: string
    noProxyAccess: false
    noPublicIp: false
    noRemoveDataDisk: false
    postStartupScript: string
    project: string
    reservationAffinity:
        consumeReservationType: string
        key: string
        values:
            - string
    serviceAccount: string
    serviceAccountScopes:
        - string
    shieldedInstanceConfig:
        enableIntegrityMonitoring: false
        enableSecureBoot: false
        enableVtpm: false
    subnet: string
    tags:
        - string
    updateTime: string
    vmImage:
        imageFamily: string
        imageName: string
        project: string

    Instance Resource Properties

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

    Inputs

    The Instance resource accepts the following input properties:

    Location string
    A reference to the zone where the machine resides.

    MachineType string
    A reference to a machine type which defines VM kind.
    AcceleratorConfig InstanceAcceleratorConfig
    The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.
    BootDiskSizeGb int
    The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
    BootDiskType string
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    ContainerImage InstanceContainerImage
    Use a container image to start the notebook instance. Structure is documented below.
    CreateTime string
    Instance creation time
    CustomGpuDriverPath string
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    DataDiskSizeGb int
    The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
    DataDiskType string
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    DesiredState string
    Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
    DiskEncryption string
    Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK.
    InstallGpuDriver bool
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    InstanceOwners List<string>
    The list of owners of this instance after creation. Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    KmsKey string
    The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
    Labels Dictionary<string, string>

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

    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.

    Metadata Dictionary<string, string>
    Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    Name string
    The name specified for the Notebook instance.
    Network string
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    NicType string
    The type of vNIC driver. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
    NoProxyAccess bool
    The notebook instance will not register with the proxy..
    NoPublicIp bool
    No public IP will be assigned to this instance.
    NoRemoveDataDisk bool
    If true, the data disk will not be auto deleted when deleting the instance.
    PostStartupScript string
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ReservationAffinity InstanceReservationAffinity
    Reservation Affinity for consuming Zonal reservation. Structure is documented below.
    ServiceAccount string
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    ServiceAccountScopes List<string>
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/userinfo.email
    ShieldedInstanceConfig InstanceShieldedInstanceConfig
    A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid Structure is documented below.
    Subnet string
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    Tags List<string>
    The Compute Engine tags to add to instance.
    UpdateTime string
    Instance update time.
    VmImage InstanceVmImage
    Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
    Location string
    A reference to the zone where the machine resides.

    MachineType string
    A reference to a machine type which defines VM kind.
    AcceleratorConfig InstanceAcceleratorConfigArgs
    The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.
    BootDiskSizeGb int
    The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
    BootDiskType string
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    ContainerImage InstanceContainerImageArgs
    Use a container image to start the notebook instance. Structure is documented below.
    CreateTime string
    Instance creation time
    CustomGpuDriverPath string
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    DataDiskSizeGb int
    The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
    DataDiskType string
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    DesiredState string
    Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
    DiskEncryption string
    Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK.
    InstallGpuDriver bool
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    InstanceOwners []string
    The list of owners of this instance after creation. Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    KmsKey string
    The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
    Labels map[string]string

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

    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.

    Metadata map[string]string
    Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    Name string
    The name specified for the Notebook instance.
    Network string
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    NicType string
    The type of vNIC driver. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
    NoProxyAccess bool
    The notebook instance will not register with the proxy..
    NoPublicIp bool
    No public IP will be assigned to this instance.
    NoRemoveDataDisk bool
    If true, the data disk will not be auto deleted when deleting the instance.
    PostStartupScript string
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ReservationAffinity InstanceReservationAffinityArgs
    Reservation Affinity for consuming Zonal reservation. Structure is documented below.
    ServiceAccount string
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    ServiceAccountScopes []string
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/userinfo.email
    ShieldedInstanceConfig InstanceShieldedInstanceConfigArgs
    A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid Structure is documented below.
    Subnet string
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    Tags []string
    The Compute Engine tags to add to instance.
    UpdateTime string
    Instance update time.
    VmImage InstanceVmImageArgs
    Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
    location String
    A reference to the zone where the machine resides.

    machineType String
    A reference to a machine type which defines VM kind.
    acceleratorConfig InstanceAcceleratorConfig
    The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.
    bootDiskSizeGb Integer
    The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
    bootDiskType String
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    containerImage InstanceContainerImage
    Use a container image to start the notebook instance. Structure is documented below.
    createTime String
    Instance creation time
    customGpuDriverPath String
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    dataDiskSizeGb Integer
    The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
    dataDiskType String
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    desiredState String
    Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
    diskEncryption String
    Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK.
    installGpuDriver Boolean
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    instanceOwners List<String>
    The list of owners of this instance after creation. Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    kmsKey String
    The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
    labels Map<String,String>

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

    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.

    metadata Map<String,String>
    Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    name String
    The name specified for the Notebook instance.
    network String
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    nicType String
    The type of vNIC driver. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
    noProxyAccess Boolean
    The notebook instance will not register with the proxy..
    noPublicIp Boolean
    No public IP will be assigned to this instance.
    noRemoveDataDisk Boolean
    If true, the data disk will not be auto deleted when deleting the instance.
    postStartupScript String
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    reservationAffinity InstanceReservationAffinity
    Reservation Affinity for consuming Zonal reservation. Structure is documented below.
    serviceAccount String
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    serviceAccountScopes List<String>
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/userinfo.email
    shieldedInstanceConfig InstanceShieldedInstanceConfig
    A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid Structure is documented below.
    subnet String
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    tags List<String>
    The Compute Engine tags to add to instance.
    updateTime String
    Instance update time.
    vmImage InstanceVmImage
    Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
    location string
    A reference to the zone where the machine resides.

    machineType string
    A reference to a machine type which defines VM kind.
    acceleratorConfig InstanceAcceleratorConfig
    The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.
    bootDiskSizeGb number
    The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
    bootDiskType string
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    containerImage InstanceContainerImage
    Use a container image to start the notebook instance. Structure is documented below.
    createTime string
    Instance creation time
    customGpuDriverPath string
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    dataDiskSizeGb number
    The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
    dataDiskType string
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    desiredState string
    Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
    diskEncryption string
    Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK.
    installGpuDriver boolean
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    instanceOwners string[]
    The list of owners of this instance after creation. Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    kmsKey string
    The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
    labels {[key: string]: string}

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

    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.

    metadata {[key: string]: string}
    Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    name string
    The name specified for the Notebook instance.
    network string
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    nicType string
    The type of vNIC driver. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
    noProxyAccess boolean
    The notebook instance will not register with the proxy..
    noPublicIp boolean
    No public IP will be assigned to this instance.
    noRemoveDataDisk boolean
    If true, the data disk will not be auto deleted when deleting the instance.
    postStartupScript string
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    reservationAffinity InstanceReservationAffinity
    Reservation Affinity for consuming Zonal reservation. Structure is documented below.
    serviceAccount string
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    serviceAccountScopes string[]
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/userinfo.email
    shieldedInstanceConfig InstanceShieldedInstanceConfig
    A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid Structure is documented below.
    subnet string
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    tags string[]
    The Compute Engine tags to add to instance.
    updateTime string
    Instance update time.
    vmImage InstanceVmImage
    Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
    location str
    A reference to the zone where the machine resides.

    machine_type str
    A reference to a machine type which defines VM kind.
    accelerator_config InstanceAcceleratorConfigArgs
    The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.
    boot_disk_size_gb int
    The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
    boot_disk_type str
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    container_image InstanceContainerImageArgs
    Use a container image to start the notebook instance. Structure is documented below.
    create_time str
    Instance creation time
    custom_gpu_driver_path str
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    data_disk_size_gb int
    The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
    data_disk_type str
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    desired_state str
    Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
    disk_encryption str
    Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK.
    install_gpu_driver bool
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    instance_owners Sequence[str]
    The list of owners of this instance after creation. Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    kms_key str
    The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
    labels Mapping[str, str]

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

    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.

    metadata Mapping[str, str]
    Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    name str
    The name specified for the Notebook instance.
    network str
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    nic_type str
    The type of vNIC driver. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
    no_proxy_access bool
    The notebook instance will not register with the proxy..
    no_public_ip bool
    No public IP will be assigned to this instance.
    no_remove_data_disk bool
    If true, the data disk will not be auto deleted when deleting the instance.
    post_startup_script str
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    reservation_affinity InstanceReservationAffinityArgs
    Reservation Affinity for consuming Zonal reservation. Structure is documented below.
    service_account str
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    service_account_scopes Sequence[str]
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/userinfo.email
    shielded_instance_config InstanceShieldedInstanceConfigArgs
    A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid Structure is documented below.
    subnet str
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    tags Sequence[str]
    The Compute Engine tags to add to instance.
    update_time str
    Instance update time.
    vm_image InstanceVmImageArgs
    Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
    location String
    A reference to the zone where the machine resides.

    machineType String
    A reference to a machine type which defines VM kind.
    acceleratorConfig Property Map
    The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.
    bootDiskSizeGb Number
    The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
    bootDiskType String
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    containerImage Property Map
    Use a container image to start the notebook instance. Structure is documented below.
    createTime String
    Instance creation time
    customGpuDriverPath String
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    dataDiskSizeGb Number
    The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
    dataDiskType String
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    desiredState String
    Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
    diskEncryption String
    Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK.
    installGpuDriver Boolean
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    instanceOwners List<String>
    The list of owners of this instance after creation. Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    kmsKey String
    The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
    labels Map<String>

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

    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.

    metadata Map<String>
    Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    name String
    The name specified for the Notebook instance.
    network String
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    nicType String
    The type of vNIC driver. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
    noProxyAccess Boolean
    The notebook instance will not register with the proxy..
    noPublicIp Boolean
    No public IP will be assigned to this instance.
    noRemoveDataDisk Boolean
    If true, the data disk will not be auto deleted when deleting the instance.
    postStartupScript String
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    reservationAffinity Property Map
    Reservation Affinity for consuming Zonal reservation. Structure is documented below.
    serviceAccount String
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    serviceAccountScopes List<String>
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/userinfo.email
    shieldedInstanceConfig Property Map
    A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid Structure is documented below.
    subnet String
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    tags List<String>
    The Compute Engine tags to add to instance.
    updateTime String
    Instance update time.
    vmImage Property Map
    Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

    Outputs

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

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProxyUri string
    The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a PROVISIONED state. If needed you can utilize pulumi up -refresh-only to await the population of this value.
    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 instance.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProxyUri string
    The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a PROVISIONED state. If needed you can utilize pulumi up -refresh-only to await the population of this value.
    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 instance.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    proxyUri String
    The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a PROVISIONED state. If needed you can utilize pulumi up -refresh-only to await the population of this value.
    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 instance.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    proxyUri string
    The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a PROVISIONED state. If needed you can utilize pulumi up -refresh-only to await the population of this value.
    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 instance.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    proxy_uri str
    The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a PROVISIONED state. If needed you can utilize pulumi up -refresh-only to await the population of this value.
    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 instance.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    proxyUri String
    The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a PROVISIONED state. If needed you can utilize pulumi up -refresh-only to await the population of this value.
    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 instance.

    Look up Existing Instance Resource

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

    public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accelerator_config: Optional[InstanceAcceleratorConfigArgs] = None,
        boot_disk_size_gb: Optional[int] = None,
        boot_disk_type: Optional[str] = None,
        container_image: Optional[InstanceContainerImageArgs] = None,
        create_time: Optional[str] = None,
        custom_gpu_driver_path: Optional[str] = None,
        data_disk_size_gb: Optional[int] = None,
        data_disk_type: Optional[str] = None,
        desired_state: Optional[str] = None,
        disk_encryption: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        install_gpu_driver: Optional[bool] = None,
        instance_owners: Optional[Sequence[str]] = None,
        kms_key: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        machine_type: Optional[str] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        network: Optional[str] = None,
        nic_type: Optional[str] = None,
        no_proxy_access: Optional[bool] = None,
        no_public_ip: Optional[bool] = None,
        no_remove_data_disk: Optional[bool] = None,
        post_startup_script: Optional[str] = None,
        project: Optional[str] = None,
        proxy_uri: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        reservation_affinity: Optional[InstanceReservationAffinityArgs] = None,
        service_account: Optional[str] = None,
        service_account_scopes: Optional[Sequence[str]] = None,
        shielded_instance_config: Optional[InstanceShieldedInstanceConfigArgs] = None,
        state: Optional[str] = None,
        subnet: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        update_time: Optional[str] = None,
        vm_image: Optional[InstanceVmImageArgs] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AcceleratorConfig InstanceAcceleratorConfig
    The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.
    BootDiskSizeGb int
    The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
    BootDiskType string
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    ContainerImage InstanceContainerImage
    Use a container image to start the notebook instance. Structure is documented below.
    CreateTime string
    Instance creation time
    CustomGpuDriverPath string
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    DataDiskSizeGb int
    The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
    DataDiskType string
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    DesiredState string
    Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
    DiskEncryption string
    Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK.
    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.
    InstallGpuDriver bool
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    InstanceOwners List<string>
    The list of owners of this instance after creation. Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    KmsKey string
    The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
    Labels Dictionary<string, string>

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

    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 string
    A reference to the zone where the machine resides.

    MachineType string
    A reference to a machine type which defines VM kind.
    Metadata Dictionary<string, string>
    Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    Name string
    The name specified for the Notebook instance.
    Network string
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    NicType string
    The type of vNIC driver. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
    NoProxyAccess bool
    The notebook instance will not register with the proxy..
    NoPublicIp bool
    No public IP will be assigned to this instance.
    NoRemoveDataDisk bool
    If true, the data disk will not be auto deleted when deleting the instance.
    PostStartupScript string
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ProxyUri string
    The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a PROVISIONED state. If needed you can utilize pulumi up -refresh-only to await the population of this value.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    ReservationAffinity InstanceReservationAffinity
    Reservation Affinity for consuming Zonal reservation. Structure is documented below.
    ServiceAccount string
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    ServiceAccountScopes List<string>
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/userinfo.email
    ShieldedInstanceConfig InstanceShieldedInstanceConfig
    A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid Structure is documented below.
    State string
    The state of this instance.
    Subnet string
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    Tags List<string>
    The Compute Engine tags to add to instance.
    UpdateTime string
    Instance update time.
    VmImage InstanceVmImage
    Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
    AcceleratorConfig InstanceAcceleratorConfigArgs
    The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.
    BootDiskSizeGb int
    The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
    BootDiskType string
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    ContainerImage InstanceContainerImageArgs
    Use a container image to start the notebook instance. Structure is documented below.
    CreateTime string
    Instance creation time
    CustomGpuDriverPath string
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    DataDiskSizeGb int
    The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
    DataDiskType string
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    DesiredState string
    Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
    DiskEncryption string
    Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK.
    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.
    InstallGpuDriver bool
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    InstanceOwners []string
    The list of owners of this instance after creation. Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    KmsKey string
    The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
    Labels map[string]string

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

    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 string
    A reference to the zone where the machine resides.

    MachineType string
    A reference to a machine type which defines VM kind.
    Metadata map[string]string
    Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    Name string
    The name specified for the Notebook instance.
    Network string
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    NicType string
    The type of vNIC driver. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
    NoProxyAccess bool
    The notebook instance will not register with the proxy..
    NoPublicIp bool
    No public IP will be assigned to this instance.
    NoRemoveDataDisk bool
    If true, the data disk will not be auto deleted when deleting the instance.
    PostStartupScript string
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ProxyUri string
    The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a PROVISIONED state. If needed you can utilize pulumi up -refresh-only to await the population of this value.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    ReservationAffinity InstanceReservationAffinityArgs
    Reservation Affinity for consuming Zonal reservation. Structure is documented below.
    ServiceAccount string
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    ServiceAccountScopes []string
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/userinfo.email
    ShieldedInstanceConfig InstanceShieldedInstanceConfigArgs
    A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid Structure is documented below.
    State string
    The state of this instance.
    Subnet string
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    Tags []string
    The Compute Engine tags to add to instance.
    UpdateTime string
    Instance update time.
    VmImage InstanceVmImageArgs
    Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
    acceleratorConfig InstanceAcceleratorConfig
    The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.
    bootDiskSizeGb Integer
    The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
    bootDiskType String
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    containerImage InstanceContainerImage
    Use a container image to start the notebook instance. Structure is documented below.
    createTime String
    Instance creation time
    customGpuDriverPath String
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    dataDiskSizeGb Integer
    The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
    dataDiskType String
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    desiredState String
    Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
    diskEncryption String
    Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK.
    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.
    installGpuDriver Boolean
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    instanceOwners List<String>
    The list of owners of this instance after creation. Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    kmsKey String
    The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
    labels Map<String,String>

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

    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 String
    A reference to the zone where the machine resides.

    machineType String
    A reference to a machine type which defines VM kind.
    metadata Map<String,String>
    Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    name String
    The name specified for the Notebook instance.
    network String
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    nicType String
    The type of vNIC driver. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
    noProxyAccess Boolean
    The notebook instance will not register with the proxy..
    noPublicIp Boolean
    No public IP will be assigned to this instance.
    noRemoveDataDisk Boolean
    If true, the data disk will not be auto deleted when deleting the instance.
    postStartupScript String
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    proxyUri String
    The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a PROVISIONED state. If needed you can utilize pulumi up -refresh-only to await the population of this value.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reservationAffinity InstanceReservationAffinity
    Reservation Affinity for consuming Zonal reservation. Structure is documented below.
    serviceAccount String
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    serviceAccountScopes List<String>
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/userinfo.email
    shieldedInstanceConfig InstanceShieldedInstanceConfig
    A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid Structure is documented below.
    state String
    The state of this instance.
    subnet String
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    tags List<String>
    The Compute Engine tags to add to instance.
    updateTime String
    Instance update time.
    vmImage InstanceVmImage
    Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
    acceleratorConfig InstanceAcceleratorConfig
    The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.
    bootDiskSizeGb number
    The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
    bootDiskType string
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    containerImage InstanceContainerImage
    Use a container image to start the notebook instance. Structure is documented below.
    createTime string
    Instance creation time
    customGpuDriverPath string
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    dataDiskSizeGb number
    The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
    dataDiskType string
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    desiredState string
    Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
    diskEncryption string
    Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK.
    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.
    installGpuDriver boolean
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    instanceOwners string[]
    The list of owners of this instance after creation. Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    kmsKey string
    The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
    labels {[key: string]: string}

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

    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 string
    A reference to the zone where the machine resides.

    machineType string
    A reference to a machine type which defines VM kind.
    metadata {[key: string]: string}
    Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    name string
    The name specified for the Notebook instance.
    network string
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    nicType string
    The type of vNIC driver. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
    noProxyAccess boolean
    The notebook instance will not register with the proxy..
    noPublicIp boolean
    No public IP will be assigned to this instance.
    noRemoveDataDisk boolean
    If true, the data disk will not be auto deleted when deleting the instance.
    postStartupScript string
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    proxyUri string
    The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a PROVISIONED state. If needed you can utilize pulumi up -refresh-only to await the population of this value.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reservationAffinity InstanceReservationAffinity
    Reservation Affinity for consuming Zonal reservation. Structure is documented below.
    serviceAccount string
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    serviceAccountScopes string[]
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/userinfo.email
    shieldedInstanceConfig InstanceShieldedInstanceConfig
    A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid Structure is documented below.
    state string
    The state of this instance.
    subnet string
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    tags string[]
    The Compute Engine tags to add to instance.
    updateTime string
    Instance update time.
    vmImage InstanceVmImage
    Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
    accelerator_config InstanceAcceleratorConfigArgs
    The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.
    boot_disk_size_gb int
    The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
    boot_disk_type str
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    container_image InstanceContainerImageArgs
    Use a container image to start the notebook instance. Structure is documented below.
    create_time str
    Instance creation time
    custom_gpu_driver_path str
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    data_disk_size_gb int
    The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
    data_disk_type str
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    desired_state str
    Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
    disk_encryption str
    Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK.
    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.
    install_gpu_driver bool
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    instance_owners Sequence[str]
    The list of owners of this instance after creation. Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    kms_key str
    The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
    labels Mapping[str, str]

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

    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 str
    A reference to the zone where the machine resides.

    machine_type str
    A reference to a machine type which defines VM kind.
    metadata Mapping[str, str]
    Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    name str
    The name specified for the Notebook instance.
    network str
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    nic_type str
    The type of vNIC driver. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
    no_proxy_access bool
    The notebook instance will not register with the proxy..
    no_public_ip bool
    No public IP will be assigned to this instance.
    no_remove_data_disk bool
    If true, the data disk will not be auto deleted when deleting the instance.
    post_startup_script str
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    proxy_uri str
    The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a PROVISIONED state. If needed you can utilize pulumi up -refresh-only to await the population of this value.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reservation_affinity InstanceReservationAffinityArgs
    Reservation Affinity for consuming Zonal reservation. Structure is documented below.
    service_account str
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    service_account_scopes Sequence[str]
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/userinfo.email
    shielded_instance_config InstanceShieldedInstanceConfigArgs
    A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid Structure is documented below.
    state str
    The state of this instance.
    subnet str
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    tags Sequence[str]
    The Compute Engine tags to add to instance.
    update_time str
    Instance update time.
    vm_image InstanceVmImageArgs
    Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
    acceleratorConfig Property Map
    The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.
    bootDiskSizeGb Number
    The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
    bootDiskType String
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    containerImage Property Map
    Use a container image to start the notebook instance. Structure is documented below.
    createTime String
    Instance creation time
    customGpuDriverPath String
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    dataDiskSizeGb Number
    The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
    dataDiskType String
    Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
    desiredState String
    Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
    diskEncryption String
    Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK.
    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.
    installGpuDriver Boolean
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    instanceOwners List<String>
    The list of owners of this instance after creation. Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    kmsKey String
    The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
    labels Map<String>

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

    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 String
    A reference to the zone where the machine resides.

    machineType String
    A reference to a machine type which defines VM kind.
    metadata Map<String>
    Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    name String
    The name specified for the Notebook instance.
    network String
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    nicType String
    The type of vNIC driver. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
    noProxyAccess Boolean
    The notebook instance will not register with the proxy..
    noPublicIp Boolean
    No public IP will be assigned to this instance.
    noRemoveDataDisk Boolean
    If true, the data disk will not be auto deleted when deleting the instance.
    postStartupScript String
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    proxyUri String
    The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a PROVISIONED state. If needed you can utilize pulumi up -refresh-only to await the population of this value.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reservationAffinity Property Map
    Reservation Affinity for consuming Zonal reservation. Structure is documented below.
    serviceAccount String
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    serviceAccountScopes List<String>
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/userinfo.email
    shieldedInstanceConfig Property Map
    A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid Structure is documented below.
    state String
    The state of this instance.
    subnet String
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    tags List<String>
    The Compute Engine tags to add to instance.
    updateTime String
    Instance update time.
    vmImage Property Map
    Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

    Supporting Types

    InstanceAcceleratorConfig, InstanceAcceleratorConfigArgs

    CoreCount int
    Count of cores of this accelerator.
    Type string
    Type of this accelerator. Possible values are: ACCELERATOR_TYPE_UNSPECIFIED, NVIDIA_TESLA_K80, NVIDIA_TESLA_P100, NVIDIA_TESLA_V100, NVIDIA_TESLA_P4, NVIDIA_TESLA_T4, NVIDIA_TESLA_T4_VWS, NVIDIA_TESLA_P100_VWS, NVIDIA_TESLA_P4_VWS, NVIDIA_TESLA_A100, TPU_V2, TPU_V3.
    CoreCount int
    Count of cores of this accelerator.
    Type string
    Type of this accelerator. Possible values are: ACCELERATOR_TYPE_UNSPECIFIED, NVIDIA_TESLA_K80, NVIDIA_TESLA_P100, NVIDIA_TESLA_V100, NVIDIA_TESLA_P4, NVIDIA_TESLA_T4, NVIDIA_TESLA_T4_VWS, NVIDIA_TESLA_P100_VWS, NVIDIA_TESLA_P4_VWS, NVIDIA_TESLA_A100, TPU_V2, TPU_V3.
    coreCount Integer
    Count of cores of this accelerator.
    type String
    Type of this accelerator. Possible values are: ACCELERATOR_TYPE_UNSPECIFIED, NVIDIA_TESLA_K80, NVIDIA_TESLA_P100, NVIDIA_TESLA_V100, NVIDIA_TESLA_P4, NVIDIA_TESLA_T4, NVIDIA_TESLA_T4_VWS, NVIDIA_TESLA_P100_VWS, NVIDIA_TESLA_P4_VWS, NVIDIA_TESLA_A100, TPU_V2, TPU_V3.
    coreCount number
    Count of cores of this accelerator.
    type string
    Type of this accelerator. Possible values are: ACCELERATOR_TYPE_UNSPECIFIED, NVIDIA_TESLA_K80, NVIDIA_TESLA_P100, NVIDIA_TESLA_V100, NVIDIA_TESLA_P4, NVIDIA_TESLA_T4, NVIDIA_TESLA_T4_VWS, NVIDIA_TESLA_P100_VWS, NVIDIA_TESLA_P4_VWS, NVIDIA_TESLA_A100, TPU_V2, TPU_V3.
    core_count int
    Count of cores of this accelerator.
    type str
    Type of this accelerator. Possible values are: ACCELERATOR_TYPE_UNSPECIFIED, NVIDIA_TESLA_K80, NVIDIA_TESLA_P100, NVIDIA_TESLA_V100, NVIDIA_TESLA_P4, NVIDIA_TESLA_T4, NVIDIA_TESLA_T4_VWS, NVIDIA_TESLA_P100_VWS, NVIDIA_TESLA_P4_VWS, NVIDIA_TESLA_A100, TPU_V2, TPU_V3.
    coreCount Number
    Count of cores of this accelerator.
    type String
    Type of this accelerator. Possible values are: ACCELERATOR_TYPE_UNSPECIFIED, NVIDIA_TESLA_K80, NVIDIA_TESLA_P100, NVIDIA_TESLA_V100, NVIDIA_TESLA_P4, NVIDIA_TESLA_T4, NVIDIA_TESLA_T4_VWS, NVIDIA_TESLA_P100_VWS, NVIDIA_TESLA_P4_VWS, NVIDIA_TESLA_A100, TPU_V2, TPU_V3.

    InstanceContainerImage, InstanceContainerImageArgs

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

    InstanceReservationAffinity, InstanceReservationAffinityArgs

    ConsumeReservationType string
    The type of Compute Reservation. Possible values are: NO_RESERVATION, ANY_RESERVATION, SPECIFIC_RESERVATION.
    Key string
    Corresponds to the label key of reservation resource.
    Values List<string>
    Corresponds to the label values of reservation resource.
    ConsumeReservationType string
    The type of Compute Reservation. Possible values are: NO_RESERVATION, ANY_RESERVATION, SPECIFIC_RESERVATION.
    Key string
    Corresponds to the label key of reservation resource.
    Values []string
    Corresponds to the label values of reservation resource.
    consumeReservationType String
    The type of Compute Reservation. Possible values are: NO_RESERVATION, ANY_RESERVATION, SPECIFIC_RESERVATION.
    key String
    Corresponds to the label key of reservation resource.
    values List<String>
    Corresponds to the label values of reservation resource.
    consumeReservationType string
    The type of Compute Reservation. Possible values are: NO_RESERVATION, ANY_RESERVATION, SPECIFIC_RESERVATION.
    key string
    Corresponds to the label key of reservation resource.
    values string[]
    Corresponds to the label values of reservation resource.
    consume_reservation_type str
    The type of Compute Reservation. Possible values are: NO_RESERVATION, ANY_RESERVATION, SPECIFIC_RESERVATION.
    key str
    Corresponds to the label key of reservation resource.
    values Sequence[str]
    Corresponds to the label values of reservation resource.
    consumeReservationType String
    The type of Compute Reservation. Possible values are: NO_RESERVATION, ANY_RESERVATION, SPECIFIC_RESERVATION.
    key String
    Corresponds to the label key of reservation resource.
    values List<String>
    Corresponds to the label values of reservation resource.

    InstanceShieldedInstanceConfig, InstanceShieldedInstanceConfigArgs

    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.

    InstanceVmImage, InstanceVmImageArgs

    Project string
    The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
    ImageFamily string
    Use this VM image family to find the image; the newest image in this family will be used.
    ImageName string
    Use VM image name to find the image.
    Project string
    The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
    ImageFamily string
    Use this VM image family to find the image; the newest image in this family will be used.
    ImageName string
    Use VM image name to find the image.
    project String
    The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
    imageFamily String
    Use this VM image family to find the image; the newest image in this family will be used.
    imageName String
    Use VM image name to find the image.
    project string
    The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
    imageFamily string
    Use this VM image family to find the image; the newest image in this family will be used.
    imageName string
    Use VM image name to find the image.
    project str
    The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
    image_family str
    Use this VM image family to find the image; the newest image in this family will be used.
    image_name str
    Use VM image name to find the image.
    project String
    The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
    imageFamily String
    Use this VM image family to find the image; the newest image in this family will be used.
    imageName String
    Use VM image name to find the image.

    Import

    Instance can be imported using any of these accepted formats:

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

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

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

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

    $ pulumi import gcp:notebooks/instance:Instance default projects/{{project}}/locations/{{location}}/instances/{{name}}

    $ pulumi import gcp:notebooks/instance:Instance default {{project}}/{{location}}/{{name}}

    $ pulumi import gcp:notebooks/instance:Instance 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 Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-gcp