gcp.notebooks.Instance
Explore with Pulumi AI
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:
- API documentation
- How-to Guides
Example Usage
Notebook Instance Basic
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()
{
Location = "us-west1-a",
MachineType = "e2-medium",
VmImage = new Gcp.Notebooks.Inputs.InstanceVmImageArgs
{
ImageFamily = "tf-latest-cpu",
Project = "deeplearning-platform-release",
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/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", ¬ebooks.InstanceArgs{
Location: pulumi.String("us-west1-a"),
MachineType: pulumi.String("e2-medium"),
VmImage: ¬ebooks.InstanceVmImageArgs{
ImageFamily: pulumi.String("tf-latest-cpu"),
Project: pulumi.String("deeplearning-platform-release"),
},
})
if err != nil {
return err
}
return nil
})
}
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()
.location("us-west1-a")
.machineType("e2-medium")
.vmImage(InstanceVmImageArgs.builder()
.imageFamily("tf-latest-cpu")
.project("deeplearning-platform-release")
.build())
.build());
}
}
import pulumi
import pulumi_gcp as gcp
instance = gcp.notebooks.Instance("instance",
location="us-west1-a",
machine_type="e2-medium",
vm_image=gcp.notebooks.InstanceVmImageArgs(
image_family="tf-latest-cpu",
project="deeplearning-platform-release",
))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const instance = new gcp.notebooks.Instance("instance", {
location: "us-west1-a",
machineType: "e2-medium",
vmImage: {
imageFamily: "tf-latest-cpu",
project: "deeplearning-platform-release",
},
});
resources:
instance:
type: gcp:notebooks:Instance
properties:
location: us-west1-a
machineType: e2-medium
vmImage:
imageFamily: tf-latest-cpu
project: deeplearning-platform-release
Notebook Instance Basic Container
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()
{
ContainerImage = new Gcp.Notebooks.Inputs.InstanceContainerImageArgs
{
Repository = "gcr.io/deeplearning-platform-release/base-cpu",
Tag = "latest",
},
Location = "us-west1-a",
MachineType = "e2-medium",
Metadata =
{
{ "proxy-mode", "service_account" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/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", ¬ebooks.InstanceArgs{
ContainerImage: ¬ebooks.InstanceContainerImageArgs{
Repository: pulumi.String("gcr.io/deeplearning-platform-release/base-cpu"),
Tag: pulumi.String("latest"),
},
Location: pulumi.String("us-west1-a"),
MachineType: pulumi.String("e2-medium"),
Metadata: pulumi.StringMap{
"proxy-mode": pulumi.String("service_account"),
},
})
if err != nil {
return err
}
return nil
})
}
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()
.containerImage(InstanceContainerImageArgs.builder()
.repository("gcr.io/deeplearning-platform-release/base-cpu")
.tag("latest")
.build())
.location("us-west1-a")
.machineType("e2-medium")
.metadata(Map.of("proxy-mode", "service_account"))
.build());
}
}
import pulumi
import pulumi_gcp as gcp
instance = gcp.notebooks.Instance("instance",
container_image=gcp.notebooks.InstanceContainerImageArgs(
repository="gcr.io/deeplearning-platform-release/base-cpu",
tag="latest",
),
location="us-west1-a",
machine_type="e2-medium",
metadata={
"proxy-mode": "service_account",
})
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const instance = new gcp.notebooks.Instance("instance", {
containerImage: {
repository: "gcr.io/deeplearning-platform-release/base-cpu",
tag: "latest",
},
location: "us-west1-a",
machineType: "e2-medium",
metadata: {
"proxy-mode": "service_account",
},
});
resources:
instance:
type: gcp:notebooks:Instance
properties:
containerImage:
repository: gcr.io/deeplearning-platform-release/base-cpu
tag: latest
location: us-west1-a
machineType: e2-medium
metadata:
proxy-mode: service_account
Notebook Instance Basic Gpu
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()
{
AcceleratorConfig = new Gcp.Notebooks.Inputs.InstanceAcceleratorConfigArgs
{
CoreCount = 1,
Type = "NVIDIA_TESLA_T4",
},
InstallGpuDriver = true,
Location = "us-west1-a",
MachineType = "n1-standard-1",
VmImage = new Gcp.Notebooks.Inputs.InstanceVmImageArgs
{
ImageFamily = "tf-latest-gpu",
Project = "deeplearning-platform-release",
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/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", ¬ebooks.InstanceArgs{
AcceleratorConfig: ¬ebooks.InstanceAcceleratorConfigArgs{
CoreCount: pulumi.Int(1),
Type: pulumi.String("NVIDIA_TESLA_T4"),
},
InstallGpuDriver: pulumi.Bool(true),
Location: pulumi.String("us-west1-a"),
MachineType: pulumi.String("n1-standard-1"),
VmImage: ¬ebooks.InstanceVmImageArgs{
ImageFamily: pulumi.String("tf-latest-gpu"),
Project: pulumi.String("deeplearning-platform-release"),
},
})
if err != nil {
return err
}
return nil
})
}
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()
.acceleratorConfig(InstanceAcceleratorConfigArgs.builder()
.coreCount(1)
.type("NVIDIA_TESLA_T4")
.build())
.installGpuDriver(true)
.location("us-west1-a")
.machineType("n1-standard-1")
.vmImage(InstanceVmImageArgs.builder()
.imageFamily("tf-latest-gpu")
.project("deeplearning-platform-release")
.build())
.build());
}
}
import pulumi
import pulumi_gcp as gcp
instance = gcp.notebooks.Instance("instance",
accelerator_config=gcp.notebooks.InstanceAcceleratorConfigArgs(
core_count=1,
type="NVIDIA_TESLA_T4",
),
install_gpu_driver=True,
location="us-west1-a",
machine_type="n1-standard-1",
vm_image=gcp.notebooks.InstanceVmImageArgs(
image_family="tf-latest-gpu",
project="deeplearning-platform-release",
))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const instance = new gcp.notebooks.Instance("instance", {
acceleratorConfig: {
coreCount: 1,
type: "NVIDIA_TESLA_T4",
},
installGpuDriver: true,
location: "us-west1-a",
machineType: "n1-standard-1",
vmImage: {
imageFamily: "tf-latest-gpu",
project: "deeplearning-platform-release",
},
});
resources:
instance:
type: gcp:notebooks:Instance
properties:
acceleratorConfig:
coreCount: 1
type: NVIDIA_TESLA_T4
installGpuDriver: true
location: us-west1-a
machineType: n1-standard-1
vmImage:
imageFamily: tf-latest-gpu
project: deeplearning-platform-release
Notebook Instance Full
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()
{
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" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v6/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", ¬ebooks.InstanceArgs{
Location: pulumi.String("us-central1-a"),
MachineType: pulumi.String("e2-medium"),
VmImage: ¬ebooks.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"),
},
})
if err != nil {
return err
}
return nil
})
}
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()
.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"))
.build());
}
}
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",
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",
})
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", {
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",
},
});
resources:
instance:
type: gcp:notebooks:Instance
properties:
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
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
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
@overload
def Instance(resource_name: 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,
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,
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,
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,
vm_image: Optional[InstanceVmImageArgs] = None)
@overload
def Instance(resource_name: str,
args: InstanceArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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.
- Machine
Type string A reference to a machine type which defines VM kind.
- Accelerator
Config InstanceAccelerator Config 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 intSize Gb 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 stringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- Container
Image InstanceContainer Image Use a container image to start the notebook instance. Structure is documented below.
- Create
Time string Instance creation time
- Custom
Gpu stringDriver Path 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 intSize Gb 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 stringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- Disk
Encryption string Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are:
DISK_ENCRYPTION_UNSPECIFIED
,GMEK
,CMEK
.- Install
Gpu boolDriver 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 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.
- Kms
Key string The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
- Labels Dictionary<string, string>
Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
- Metadata Dictionary<string, string>
Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
- Name string
The name specified for the Notebook instance.
- Network string
The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
- Nic
Type string The type of vNIC driver. Possible values are:
UNSPECIFIED_NIC_TYPE
,VIRTIO_NET
,GVNIC
.- No
Proxy boolAccess The notebook instance will not register with the proxy..
- No
Public boolIp No public IP will be assigned to this instance.
- No
Remove boolData Disk If true, the data disk will not be auto deleted when deleting the instance.
- Post
Startup stringScript 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.
- Reservation
Affinity InstanceReservation Affinity Reservation Affinity for consuming Zonal reservation. Structure is documented below.
- Service
Account 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.
- Service
Account List<string>Scopes 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 InstanceConfig Shielded Instance Config 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}
- List<string>
The Compute Engine tags to add to instance.
- Update
Time string Instance update time.
- Vm
Image InstanceVm Image 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.
- Machine
Type string A reference to a machine type which defines VM kind.
- Accelerator
Config InstanceAccelerator Config Args 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 intSize Gb 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 stringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- Container
Image InstanceContainer Image Args Use a container image to start the notebook instance. Structure is documented below.
- Create
Time string Instance creation time
- Custom
Gpu stringDriver Path 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 intSize Gb 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 stringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- Disk
Encryption string Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are:
DISK_ENCRYPTION_UNSPECIFIED
,GMEK
,CMEK
.- Install
Gpu boolDriver 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 []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.
- Kms
Key string The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
- Labels map[string]string
Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
- Metadata map[string]string
Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
- Name string
The name specified for the Notebook instance.
- Network string
The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
- Nic
Type string The type of vNIC driver. Possible values are:
UNSPECIFIED_NIC_TYPE
,VIRTIO_NET
,GVNIC
.- No
Proxy boolAccess The notebook instance will not register with the proxy..
- No
Public boolIp No public IP will be assigned to this instance.
- No
Remove boolData Disk If true, the data disk will not be auto deleted when deleting the instance.
- Post
Startup stringScript 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.
- Reservation
Affinity InstanceReservation Affinity Args Reservation Affinity for consuming Zonal reservation. Structure is documented below.
- Service
Account 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.
- Service
Account []stringScopes 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 InstanceConfig Shielded Instance Config Args 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}
- []string
The Compute Engine tags to add to instance.
- Update
Time string Instance update time.
- Vm
Image InstanceVm Image Args 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.
- machine
Type String A reference to a machine type which defines VM kind.
- accelerator
Config InstanceAccelerator Config 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 IntegerSize Gb 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 StringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- container
Image InstanceContainer Image Use a container image to start the notebook instance. Structure is documented below.
- create
Time String Instance creation time
- custom
Gpu StringDriver Path 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 IntegerSize Gb 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 StringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- disk
Encryption String Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are:
DISK_ENCRYPTION_UNSPECIFIED
,GMEK
,CMEK
.- install
Gpu BooleanDriver 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 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.
- kms
Key String The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
- labels Map<String,String>
Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
- metadata Map<String,String>
Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
- name String
The name specified for the Notebook instance.
- network String
The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
- nic
Type String The type of vNIC driver. Possible values are:
UNSPECIFIED_NIC_TYPE
,VIRTIO_NET
,GVNIC
.- no
Proxy BooleanAccess The notebook instance will not register with the proxy..
- no
Public BooleanIp No public IP will be assigned to this instance.
- no
Remove BooleanData Disk If true, the data disk will not be auto deleted when deleting the instance.
- post
Startup StringScript 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.
- reservation
Affinity InstanceReservation Affinity Reservation Affinity for consuming Zonal reservation. Structure is documented below.
- service
Account 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.
- service
Account List<String>Scopes 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 InstanceConfig Shielded Instance Config 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}
- List<String>
The Compute Engine tags to add to instance.
- update
Time String Instance update time.
- vm
Image InstanceVm Image 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.
- machine
Type string A reference to a machine type which defines VM kind.
- accelerator
Config InstanceAccelerator Config 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 numberSize Gb 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 stringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- container
Image InstanceContainer Image Use a container image to start the notebook instance. Structure is documented below.
- create
Time string Instance creation time
- custom
Gpu stringDriver Path 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 numberSize Gb 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 stringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- disk
Encryption string Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are:
DISK_ENCRYPTION_UNSPECIFIED
,GMEK
,CMEK
.- install
Gpu booleanDriver 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 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.
- kms
Key string The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
- labels {[key: string]: string}
Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
- metadata {[key: string]: string}
Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
- name string
The name specified for the Notebook instance.
- network string
The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
- nic
Type string The type of vNIC driver. Possible values are:
UNSPECIFIED_NIC_TYPE
,VIRTIO_NET
,GVNIC
.- no
Proxy booleanAccess The notebook instance will not register with the proxy..
- no
Public booleanIp No public IP will be assigned to this instance.
- no
Remove booleanData Disk If true, the data disk will not be auto deleted when deleting the instance.
- post
Startup stringScript 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.
- reservation
Affinity InstanceReservation Affinity Reservation Affinity for consuming Zonal reservation. Structure is documented below.
- service
Account 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.
- service
Account string[]Scopes 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 InstanceConfig Shielded Instance Config 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}
- string[]
The Compute Engine tags to add to instance.
- update
Time string Instance update time.
- vm
Image InstanceVm Image 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 InstanceAccelerator Config Args 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_ intsize_ gb 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_ strtype Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- container_
image InstanceContainer Image Args Use a container image to start the notebook instance. Structure is documented below.
- create_
time str Instance creation time
- custom_
gpu_ strdriver_ path 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_ intsize_ gb 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_ strtype Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- 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_ booldriver 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" }.
- 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_ boolaccess The notebook instance will not register with the proxy..
- no_
public_ boolip No public IP will be assigned to this instance.
- no_
remove_ booldata_ disk If true, the data disk will not be auto deleted when deleting the instance.
- post_
startup_ strscript 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 InstanceReservation Affinity Args 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_ Sequence[str]scopes 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_ Instanceconfig Shielded Instance Config Args 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}
- Sequence[str]
The Compute Engine tags to add to instance.
- update_
time str Instance update time.
- vm_
image InstanceVm Image Args 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.
- machine
Type String A reference to a machine type which defines VM kind.
- accelerator
Config 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.
- boot
Disk NumberSize Gb 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 StringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- container
Image Property Map Use a container image to start the notebook instance. Structure is documented below.
- create
Time String Instance creation time
- custom
Gpu StringDriver Path 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 NumberSize Gb 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 StringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- disk
Encryption String Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are:
DISK_ENCRYPTION_UNSPECIFIED
,GMEK
,CMEK
.- install
Gpu BooleanDriver 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 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.
- kms
Key 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" }.
- 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}
- nic
Type String The type of vNIC driver. Possible values are:
UNSPECIFIED_NIC_TYPE
,VIRTIO_NET
,GVNIC
.- no
Proxy BooleanAccess The notebook instance will not register with the proxy..
- no
Public BooleanIp No public IP will be assigned to this instance.
- no
Remove BooleanData Disk If true, the data disk will not be auto deleted when deleting the instance.
- post
Startup StringScript 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.
- reservation
Affinity Property Map Reservation Affinity for consuming Zonal reservation. Structure is documented below.
- service
Account 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.
- service
Account List<String>Scopes 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 Property MapConfig 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}
- List<String>
The Compute Engine tags to add to instance.
- update
Time String Instance update time.
- vm
Image 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:
- Id string
The provider-assigned unique ID for this managed resource.
- Proxy
Uri 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 utilizepulumi up -refresh-only
to await the population of this value.- State string
The state of this instance.
- Id string
The provider-assigned unique ID for this managed resource.
- Proxy
Uri 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 utilizepulumi up -refresh-only
to await the population of this value.- State string
The state of this instance.
- id String
The provider-assigned unique ID for this managed resource.
- proxy
Uri 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 utilizepulumi up -refresh-only
to await the population of this value.- state String
The state of this instance.
- id string
The provider-assigned unique ID for this managed resource.
- proxy
Uri 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 utilizepulumi up -refresh-only
to await the population of this value.- state string
The state of this instance.
- id str
The provider-assigned unique ID for this managed resource.
- proxy_
uri str The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a
PROVISIONED
state. If needed you can utilizepulumi up -refresh-only
to await the population of this value.- state str
The state of this instance.
- id String
The provider-assigned unique ID for this managed resource.
- proxy
Uri 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 utilizepulumi up -refresh-only
to await the population of this value.- 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,
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,
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,
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.
- Accelerator
Config InstanceAccelerator Config 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 intSize Gb 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 stringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- Container
Image InstanceContainer Image Use a container image to start the notebook instance. Structure is documented below.
- Create
Time string Instance creation time
- Custom
Gpu stringDriver Path 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 intSize Gb 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 stringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- Disk
Encryption string Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are:
DISK_ENCRYPTION_UNSPECIFIED
,GMEK
,CMEK
.- Install
Gpu boolDriver 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 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.
- Kms
Key string The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
- Labels Dictionary<string, string>
Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
- Location string
A reference to the zone where the machine resides.
- Machine
Type 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}
- Nic
Type string The type of vNIC driver. Possible values are:
UNSPECIFIED_NIC_TYPE
,VIRTIO_NET
,GVNIC
.- No
Proxy boolAccess The notebook instance will not register with the proxy..
- No
Public boolIp No public IP will be assigned to this instance.
- No
Remove boolData Disk If true, the data disk will not be auto deleted when deleting the instance.
- Post
Startup stringScript 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.
- Proxy
Uri 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 utilizepulumi up -refresh-only
to await the population of this value.- Reservation
Affinity InstanceReservation Affinity Reservation Affinity for consuming Zonal reservation. Structure is documented below.
- Service
Account 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.
- Service
Account List<string>Scopes 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 InstanceConfig Shielded Instance Config 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}
- List<string>
The Compute Engine tags to add to instance.
- Update
Time string Instance update time.
- Vm
Image InstanceVm Image Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
- Accelerator
Config InstanceAccelerator Config Args 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 intSize Gb 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 stringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- Container
Image InstanceContainer Image Args Use a container image to start the notebook instance. Structure is documented below.
- Create
Time string Instance creation time
- Custom
Gpu stringDriver Path 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 intSize Gb 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 stringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- Disk
Encryption string Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are:
DISK_ENCRYPTION_UNSPECIFIED
,GMEK
,CMEK
.- Install
Gpu boolDriver 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 []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.
- Kms
Key string The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
- Labels map[string]string
Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
- Location string
A reference to the zone where the machine resides.
- Machine
Type 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}
- Nic
Type string The type of vNIC driver. Possible values are:
UNSPECIFIED_NIC_TYPE
,VIRTIO_NET
,GVNIC
.- No
Proxy boolAccess The notebook instance will not register with the proxy..
- No
Public boolIp No public IP will be assigned to this instance.
- No
Remove boolData Disk If true, the data disk will not be auto deleted when deleting the instance.
- Post
Startup stringScript 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.
- Proxy
Uri 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 utilizepulumi up -refresh-only
to await the population of this value.- Reservation
Affinity InstanceReservation Affinity Args Reservation Affinity for consuming Zonal reservation. Structure is documented below.
- Service
Account 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.
- Service
Account []stringScopes 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 InstanceConfig Shielded Instance Config Args 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}
- []string
The Compute Engine tags to add to instance.
- Update
Time string Instance update time.
- Vm
Image InstanceVm Image Args Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
- accelerator
Config InstanceAccelerator Config 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 IntegerSize Gb 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 StringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- container
Image InstanceContainer Image Use a container image to start the notebook instance. Structure is documented below.
- create
Time String Instance creation time
- custom
Gpu StringDriver Path 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 IntegerSize Gb 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 StringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- disk
Encryption String Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are:
DISK_ENCRYPTION_UNSPECIFIED
,GMEK
,CMEK
.- install
Gpu BooleanDriver 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 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.
- kms
Key String The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
- labels Map<String,String>
Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
- location String
A reference to the zone where the machine resides.
- machine
Type 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}
- nic
Type String The type of vNIC driver. Possible values are:
UNSPECIFIED_NIC_TYPE
,VIRTIO_NET
,GVNIC
.- no
Proxy BooleanAccess The notebook instance will not register with the proxy..
- no
Public BooleanIp No public IP will be assigned to this instance.
- no
Remove BooleanData Disk If true, the data disk will not be auto deleted when deleting the instance.
- post
Startup StringScript 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.
- proxy
Uri 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 utilizepulumi up -refresh-only
to await the population of this value.- reservation
Affinity InstanceReservation Affinity Reservation Affinity for consuming Zonal reservation. Structure is documented below.
- service
Account 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.
- service
Account List<String>Scopes 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 InstanceConfig Shielded Instance Config 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}
- List<String>
The Compute Engine tags to add to instance.
- update
Time String Instance update time.
- vm
Image InstanceVm Image Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
- accelerator
Config InstanceAccelerator Config 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 numberSize Gb 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 stringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- container
Image InstanceContainer Image Use a container image to start the notebook instance. Structure is documented below.
- create
Time string Instance creation time
- custom
Gpu stringDriver Path 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 numberSize Gb 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 stringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- disk
Encryption string Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are:
DISK_ENCRYPTION_UNSPECIFIED
,GMEK
,CMEK
.- install
Gpu booleanDriver 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 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.
- kms
Key string The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
- labels {[key: string]: string}
Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
- location string
A reference to the zone where the machine resides.
- machine
Type 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}
- nic
Type string The type of vNIC driver. Possible values are:
UNSPECIFIED_NIC_TYPE
,VIRTIO_NET
,GVNIC
.- no
Proxy booleanAccess The notebook instance will not register with the proxy..
- no
Public booleanIp No public IP will be assigned to this instance.
- no
Remove booleanData Disk If true, the data disk will not be auto deleted when deleting the instance.
- post
Startup stringScript 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.
- proxy
Uri 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 utilizepulumi up -refresh-only
to await the population of this value.- reservation
Affinity InstanceReservation Affinity Reservation Affinity for consuming Zonal reservation. Structure is documented below.
- service
Account 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.
- service
Account string[]Scopes 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 InstanceConfig Shielded Instance Config 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}
- string[]
The Compute Engine tags to add to instance.
- update
Time string Instance update time.
- vm
Image InstanceVm Image Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
- accelerator_
config InstanceAccelerator Config Args 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_ intsize_ gb 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_ strtype Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- container_
image InstanceContainer Image Args Use a container image to start the notebook instance. Structure is documented below.
- create_
time str Instance creation time
- custom_
gpu_ strdriver_ path 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_ intsize_ gb 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_ strtype Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- 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_ booldriver 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" }.
- 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_ boolaccess The notebook instance will not register with the proxy..
- no_
public_ boolip No public IP will be assigned to this instance.
- no_
remove_ booldata_ disk If true, the data disk will not be auto deleted when deleting the instance.
- post_
startup_ strscript 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 utilizepulumi up -refresh-only
to await the population of this value.- reservation_
affinity InstanceReservation Affinity Args 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_ Sequence[str]scopes 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_ Instanceconfig Shielded Instance Config Args 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}
- Sequence[str]
The Compute Engine tags to add to instance.
- update_
time str Instance update time.
- vm_
image InstanceVm Image Args Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
- accelerator
Config 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.
- boot
Disk NumberSize Gb 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 StringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- container
Image Property Map Use a container image to start the notebook instance. Structure is documented below.
- create
Time String Instance creation time
- custom
Gpu StringDriver Path 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 NumberSize Gb 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 StringType Possible disk types for notebook instances. Possible values are:
DISK_TYPE_UNSPECIFIED
,PD_STANDARD
,PD_SSD
,PD_BALANCED
,PD_EXTREME
.- disk
Encryption String Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are:
DISK_ENCRYPTION_UNSPECIFIED
,GMEK
,CMEK
.- install
Gpu BooleanDriver 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 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.
- kms
Key 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" }.
- location String
A reference to the zone where the machine resides.
- machine
Type 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}
- nic
Type String The type of vNIC driver. Possible values are:
UNSPECIFIED_NIC_TYPE
,VIRTIO_NET
,GVNIC
.- no
Proxy BooleanAccess The notebook instance will not register with the proxy..
- no
Public BooleanIp No public IP will be assigned to this instance.
- no
Remove BooleanData Disk If true, the data disk will not be auto deleted when deleting the instance.
- post
Startup StringScript 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.
- proxy
Uri 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 utilizepulumi up -refresh-only
to await the population of this value.- reservation
Affinity Property Map Reservation Affinity for consuming Zonal reservation. Structure is documented below.
- service
Account 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.
- service
Account List<String>Scopes 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 Property MapConfig 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}
- List<String>
The Compute Engine tags to add to instance.
- update
Time String Instance update time.
- vm
Image Property Map Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
Supporting Types
InstanceAcceleratorConfig, InstanceAcceleratorConfigArgs
- Core
Count 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
.
- Core
Count 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
.
- core
Count 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
.
- core
Count 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
.
- core
Count 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
- Consume
Reservation stringType 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.
- Consume
Reservation stringType 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 StringType 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.
- consume
Reservation stringType 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_ strtype 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.
- consume
Reservation StringType 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
- Enable
Integrity boolMonitoring 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 boolBoot 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.
- Enable
Integrity boolMonitoring 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 boolBoot 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.
- enable
Integrity BooleanMonitoring 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 BooleanBoot 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 Boolean Defines whether the instance has the vTPM enabled. Enabled by default.
- enable
Integrity booleanMonitoring 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 booleanBoot 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 boolean Defines whether the instance has the vTPM enabled. Enabled by default.
- enable_
integrity_ boolmonitoring 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_ boolboot 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.
- enable
Integrity BooleanMonitoring 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 BooleanBoot 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 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}
- Image
Family string Use this VM image family to find the image; the newest image in this family will be used.
- Image
Name 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}
- Image
Family string Use this VM image family to find the image; the newest image in this family will be used.
- Image
Name 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}
- image
Family String Use this VM image family to find the image; the newest image in this family will be used.
- image
Name 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}
- image
Family string Use this VM image family to find the image; the newest image in this family will be used.
- image
Name 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}
- image
Family String Use this VM image family to find the image; the newest image in this family will be used.
- image
Name String Use VM image name to find the image.
Import
Instance can be imported using any of these accepted formats
$ 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}}
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.