Instance class

Creates a new Instance in a given project and location. Auto-naming is currently not supported for this resource.

Constructors

Instance(String name, {InstanceArgs? args, CustomResourceOptions? options})

Creates a new Instance. name The Pulumi resource name. args Arguments used to configure this Instance. The set of arguments for Instance. options Resource options controlling this resource's behavior.

Properties

acceleratorConfig ↔ Output<AcceleratorConfigResponse>

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

late, final

bootDiskSizeGb ↔ Output<String>

Input only. 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.

late, final

bootDiskType ↔ Output<String>

Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

late, final

canIpForward ↔ Output<bool>

Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

containerImage ↔ Output<ContainerImageResponse>

Use a container image to start the notebook instance.

late, final

createTime ↔ Output<String>

Instance creation time.

late, final

creator ↔ Output<String>

Email address of entity that sent original CreateInstance request.

late, final

customGpuDriverPath ↔ Output<String>

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

late, final

dataDiskSizeGb ↔ Output<String>

Input only. 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.

late, final

dataDiskType ↔ Output<String>

Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

late, final

diskEncryption ↔ Output<String>

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

late, final

disks ↔ Output<List<Map<String, dynamic>>>

Attached disks to notebook instance.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

installGpuDriver ↔ Output<bool>

Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.

late, final

instanceId ↔ Output<String>

Required. User-defined unique ID of this instance.

late, final

instanceMigrationEligibility ↔ Output<InstanceMigrationEligibilityResponse>

Checks how feasible a migration from UmN to WbI is.

late, final

instanceOwners ↔ Output<List<String>>

Input only. The owner of this instance after creation. Format: [e-mail] 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.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

kmsKey ↔ Output<String>

Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id} Learn more about using your own encryption keys.

late, final

labels ↔ Output<Map<String, String>>

Labels to apply to this instance. These can be later modified by the setLabels method.

late, final

location ↔ Output<String>

late, final

machineType ↔ Output<String>

The Compute Engine machine type of this instance.

late, final

metadata ↔ Output<Map<String, String>>

Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the gcs-data-bucket metadata tag. Format: "--metadata=gcs-data-bucket=``BUCKET''".

late, final

migrated ↔ Output<bool>

Bool indicating whether this notebook has been migrated to a Workbench Instance

late, final

name ↔ Output<String>

The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

late, final

network ↔ Output<String>

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

late, final

nicType ↔ Output<String>

Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

late, final

noProxyAccess ↔ Output<bool>

If true, the notebook instance will not register with the proxy.

late, final

noPublicIp ↔ Output<bool>

If true, no external IP will be assigned to this instance.

late, final

noRemoveDataDisk ↔ Output<bool>

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

late, final

postStartupScript ↔ Output<String>

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

late, final

project ↔ Output<String>

late, final

proxyUri ↔ Output<String>

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

late, final

reservationAffinity ↔ Output<ReservationAffinityResponse>

Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceAccount ↔ Output<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.

late, final

serviceAccountScopes ↔ Output<List<String>>

Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute

late, final

shieldedInstanceConfig ↔ Output<ShieldedInstanceConfigResponse>

Optional. Shielded VM configuration. Images using supported Shielded VM features.

late, final

state ↔ Output<String>

The state of this instance.

late, final

subnet ↔ Output<String>

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

late, final

tags ↔ Output<List<String>>

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

Instance update time.

late, final

upgradeHistory ↔ Output<List<Map<String, dynamic>>>

The upgrade history of this instance.

late, final

urn ↔ Output<String>

late, final, inherited

vmImage ↔ Output<VmImageResponse>

Use a Compute Engine VM image to start the notebook instance.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited