Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. notebooks
  5. notebooks/v1
  6. getInstance

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.notebooks/v1.getInstance

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets details of a single Instance.

    Using getInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
    def get_instance(instance_id: Optional[str] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                 location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
    func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

    > Note: This function is named LookupInstance in the Go SDK.

    public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:notebooks/v1:getInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    Location string
    Project string
    InstanceId string
    Location string
    Project string
    instanceId String
    location String
    project String
    instanceId string
    location string
    project string
    instanceId String
    location String
    project String

    getInstance Result

    The following output properties are available:

    AcceleratorConfig Pulumi.GoogleNative.Notebooks.V1.Outputs.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.
    BootDiskSizeGb 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.
    BootDiskType string
    Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
    CanIpForward bool
    Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
    ContainerImage Pulumi.GoogleNative.Notebooks.V1.Outputs.ContainerImageResponse
    Use a container image to start the notebook instance.
    CreateTime string
    Instance creation time.
    Creator string
    Email address of entity that sent original CreateInstance request.
    CustomGpuDriverPath string
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    DataDiskSizeGb 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.
    DataDiskType string
    Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
    DiskEncryption string
    Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
    Disks List<Pulumi.GoogleNative.Notebooks.V1.Outputs.DiskResponse>
    Attached disks to notebook instance.
    InstallGpuDriver bool
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    InstanceMigrationEligibility Pulumi.GoogleNative.Notebooks.V1.Outputs.InstanceMigrationEligibilityResponse
    Checks how feasible a migration from UmN to WbI is.
    InstanceOwners List<string>
    Input only. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    KmsKey string
    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.
    Labels Dictionary<string, string>
    Labels to apply to this instance. These can be later modified by the setLabels method.
    MachineType string
    The Compute Engine machine type of this instance.
    Metadata Dictionary<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''".
    Migrated bool
    Bool indicating whether this notebook has been migrated to a Workbench Instance
    Name string
    The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
    Network string
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    NicType string
    Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
    NoProxyAccess bool
    If true, the notebook instance will not register with the proxy.
    NoPublicIp bool
    If true, no external IP will be assigned to this instance.
    NoRemoveDataDisk bool
    Input only. If true, the data disk will not be auto deleted when deleting the instance.
    PostStartupScript string
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    ProxyUri string
    The proxy endpoint that is used to access the Jupyter notebook.
    ReservationAffinity Pulumi.GoogleNative.Notebooks.V1.Outputs.ReservationAffinityResponse
    Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.
    ServiceAccount string
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    ServiceAccountScopes List<string>
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
    ShieldedInstanceConfig Pulumi.GoogleNative.Notebooks.V1.Outputs.ShieldedInstanceConfigResponse
    Optional. Shielded VM configuration. Images using supported Shielded VM features.
    State string
    The state of this instance.
    Subnet string
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    Tags List<string>
    Optional. The Compute Engine tags to add to runtime (see Tagging instances).
    UpdateTime string
    Instance update time.
    UpgradeHistory List<Pulumi.GoogleNative.Notebooks.V1.Outputs.UpgradeHistoryEntryResponse>
    The upgrade history of this instance.
    VmImage Pulumi.GoogleNative.Notebooks.V1.Outputs.VmImageResponse
    Use a Compute Engine VM image to start the notebook instance.
    AcceleratorConfig 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.
    BootDiskSizeGb 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.
    BootDiskType string
    Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
    CanIpForward bool
    Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
    ContainerImage ContainerImageResponse
    Use a container image to start the notebook instance.
    CreateTime string
    Instance creation time.
    Creator string
    Email address of entity that sent original CreateInstance request.
    CustomGpuDriverPath string
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    DataDiskSizeGb 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.
    DataDiskType string
    Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
    DiskEncryption string
    Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
    Disks []DiskResponse
    Attached disks to notebook instance.
    InstallGpuDriver bool
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    InstanceMigrationEligibility InstanceMigrationEligibilityResponse
    Checks how feasible a migration from UmN to WbI is.
    InstanceOwners []string
    Input only. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    KmsKey string
    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.
    Labels map[string]string
    Labels to apply to this instance. These can be later modified by the setLabels method.
    MachineType string
    The Compute Engine machine type of this instance.
    Metadata 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''".
    Migrated bool
    Bool indicating whether this notebook has been migrated to a Workbench Instance
    Name string
    The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
    Network string
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    NicType string
    Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
    NoProxyAccess bool
    If true, the notebook instance will not register with the proxy.
    NoPublicIp bool
    If true, no external IP will be assigned to this instance.
    NoRemoveDataDisk bool
    Input only. If true, the data disk will not be auto deleted when deleting the instance.
    PostStartupScript string
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    ProxyUri string
    The proxy endpoint that is used to access the Jupyter notebook.
    ReservationAffinity ReservationAffinityResponse
    Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.
    ServiceAccount string
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    ServiceAccountScopes []string
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
    ShieldedInstanceConfig ShieldedInstanceConfigResponse
    Optional. Shielded VM configuration. Images using supported Shielded VM features.
    State string
    The state of this instance.
    Subnet string
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    Tags []string
    Optional. The Compute Engine tags to add to runtime (see Tagging instances).
    UpdateTime string
    Instance update time.
    UpgradeHistory []UpgradeHistoryEntryResponse
    The upgrade history of this instance.
    VmImage VmImageResponse
    Use a Compute Engine VM image to start the notebook instance.
    acceleratorConfig 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.
    bootDiskSizeGb 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.
    bootDiskType String
    Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
    canIpForward Boolean
    Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
    containerImage ContainerImageResponse
    Use a container image to start the notebook instance.
    createTime String
    Instance creation time.
    creator String
    Email address of entity that sent original CreateInstance request.
    customGpuDriverPath String
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    dataDiskSizeGb 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.
    dataDiskType String
    Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
    diskEncryption String
    Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
    disks List<DiskResponse>
    Attached disks to notebook instance.
    installGpuDriver Boolean
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    instanceMigrationEligibility InstanceMigrationEligibilityResponse
    Checks how feasible a migration from UmN to WbI is.
    instanceOwners List<String>
    Input only. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    kmsKey String
    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.
    labels Map<String,String>
    Labels to apply to this instance. These can be later modified by the setLabels method.
    machineType String
    The Compute Engine machine type of this instance.
    metadata 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''".
    migrated Boolean
    Bool indicating whether this notebook has been migrated to a Workbench Instance
    name String
    The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
    network String
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    nicType String
    Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
    noProxyAccess Boolean
    If true, the notebook instance will not register with the proxy.
    noPublicIp Boolean
    If true, no external IP will be assigned to this instance.
    noRemoveDataDisk Boolean
    Input only. If true, the data disk will not be auto deleted when deleting the instance.
    postStartupScript String
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    proxyUri String
    The proxy endpoint that is used to access the Jupyter notebook.
    reservationAffinity ReservationAffinityResponse
    Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.
    serviceAccount String
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    serviceAccountScopes List<String>
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
    shieldedInstanceConfig ShieldedInstanceConfigResponse
    Optional. Shielded VM configuration. Images using supported Shielded VM features.
    state String
    The state of this instance.
    subnet String
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    tags List<String>
    Optional. The Compute Engine tags to add to runtime (see Tagging instances).
    updateTime String
    Instance update time.
    upgradeHistory List<UpgradeHistoryEntryResponse>
    The upgrade history of this instance.
    vmImage VmImageResponse
    Use a Compute Engine VM image to start the notebook instance.
    acceleratorConfig 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.
    bootDiskSizeGb 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.
    bootDiskType string
    Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
    canIpForward boolean
    Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
    containerImage ContainerImageResponse
    Use a container image to start the notebook instance.
    createTime string
    Instance creation time.
    creator string
    Email address of entity that sent original CreateInstance request.
    customGpuDriverPath string
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    dataDiskSizeGb 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.
    dataDiskType string
    Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
    diskEncryption string
    Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
    disks DiskResponse[]
    Attached disks to notebook instance.
    installGpuDriver boolean
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    instanceMigrationEligibility InstanceMigrationEligibilityResponse
    Checks how feasible a migration from UmN to WbI is.
    instanceOwners string[]
    Input only. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    kmsKey string
    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.
    labels {[key: string]: string}
    Labels to apply to this instance. These can be later modified by the setLabels method.
    machineType string
    The Compute Engine machine type of this instance.
    metadata {[key: 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''".
    migrated boolean
    Bool indicating whether this notebook has been migrated to a Workbench Instance
    name string
    The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
    network string
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    nicType string
    Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
    noProxyAccess boolean
    If true, the notebook instance will not register with the proxy.
    noPublicIp boolean
    If true, no external IP will be assigned to this instance.
    noRemoveDataDisk boolean
    Input only. If true, the data disk will not be auto deleted when deleting the instance.
    postStartupScript string
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    proxyUri string
    The proxy endpoint that is used to access the Jupyter notebook.
    reservationAffinity ReservationAffinityResponse
    Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.
    serviceAccount string
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    serviceAccountScopes string[]
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
    shieldedInstanceConfig ShieldedInstanceConfigResponse
    Optional. Shielded VM configuration. Images using supported Shielded VM features.
    state string
    The state of this instance.
    subnet string
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    tags string[]
    Optional. The Compute Engine tags to add to runtime (see Tagging instances).
    updateTime string
    Instance update time.
    upgradeHistory UpgradeHistoryEntryResponse[]
    The upgrade history of this instance.
    vmImage VmImageResponse
    Use a Compute Engine VM image to start the notebook instance.
    accelerator_config 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.
    boot_disk_size_gb str
    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.
    boot_disk_type str
    Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
    can_ip_forward bool
    Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
    container_image ContainerImageResponse
    Use a container image to start the notebook instance.
    create_time str
    Instance creation time.
    creator str
    Email address of entity that sent original CreateInstance request.
    custom_gpu_driver_path str
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    data_disk_size_gb str
    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.
    data_disk_type str
    Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
    disk_encryption str
    Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
    disks Sequence[DiskResponse]
    Attached disks to notebook instance.
    install_gpu_driver bool
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    instance_migration_eligibility InstanceMigrationEligibilityResponse
    Checks how feasible a migration from UmN to WbI is.
    instance_owners Sequence[str]
    Input only. The owner 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
    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.
    labels Mapping[str, str]
    Labels to apply to this instance. These can be later modified by the setLabels method.
    machine_type str
    The Compute Engine machine type of this instance.
    metadata Mapping[str, str]
    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''".
    migrated bool
    Bool indicating whether this notebook has been migrated to a Workbench Instance
    name str
    The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
    network str
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    nic_type str
    Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
    no_proxy_access bool
    If true, the notebook instance will not register with the proxy.
    no_public_ip bool
    If true, no external IP will be assigned to this instance.
    no_remove_data_disk bool
    Input only. If true, the data disk will not be auto deleted when deleting the instance.
    post_startup_script str
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    proxy_uri str
    The proxy endpoint that is used to access the Jupyter notebook.
    reservation_affinity ReservationAffinityResponse
    Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.
    service_account str
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    service_account_scopes Sequence[str]
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
    shielded_instance_config ShieldedInstanceConfigResponse
    Optional. Shielded VM configuration. Images using supported Shielded VM features.
    state str
    The state of this instance.
    subnet str
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    tags Sequence[str]
    Optional. The Compute Engine tags to add to runtime (see Tagging instances).
    update_time str
    Instance update time.
    upgrade_history Sequence[UpgradeHistoryEntryResponse]
    The upgrade history of this instance.
    vm_image VmImageResponse
    Use a Compute Engine VM image to start the notebook instance.
    acceleratorConfig Property Map
    The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machine_type you have selected.
    bootDiskSizeGb 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.
    bootDiskType String
    Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
    canIpForward Boolean
    Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
    containerImage Property Map
    Use a container image to start the notebook instance.
    createTime String
    Instance creation time.
    creator String
    Email address of entity that sent original CreateInstance request.
    customGpuDriverPath String
    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
    dataDiskSizeGb 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.
    dataDiskType String
    Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
    diskEncryption String
    Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
    disks List<Property Map>
    Attached disks to notebook instance.
    installGpuDriver Boolean
    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
    instanceMigrationEligibility Property Map
    Checks how feasible a migration from UmN to WbI is.
    instanceOwners List<String>
    Input only. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
    kmsKey String
    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.
    labels Map<String>
    Labels to apply to this instance. These can be later modified by the setLabels method.
    machineType String
    The Compute Engine machine type of this instance.
    metadata Map<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''".
    migrated Boolean
    Bool indicating whether this notebook has been migrated to a Workbench Instance
    name String
    The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
    network String
    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
    nicType String
    Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
    noProxyAccess Boolean
    If true, the notebook instance will not register with the proxy.
    noPublicIp Boolean
    If true, no external IP will be assigned to this instance.
    noRemoveDataDisk Boolean
    Input only. If true, the data disk will not be auto deleted when deleting the instance.
    postStartupScript String
    Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
    proxyUri String
    The proxy endpoint that is used to access the Jupyter notebook.
    reservationAffinity Property Map
    Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.
    serviceAccount String
    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
    serviceAccountScopes List<String>
    Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
    shieldedInstanceConfig Property Map
    Optional. Shielded VM configuration. Images using supported Shielded VM features.
    state String
    The state of this instance.
    subnet String
    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
    tags List<String>
    Optional. The Compute Engine tags to add to runtime (see Tagging instances).
    updateTime String
    Instance update time.
    upgradeHistory List<Property Map>
    The upgrade history of this instance.
    vmImage Property Map
    Use a Compute Engine VM image to start the notebook instance.

    Supporting Types

    AcceleratorConfigResponse

    CoreCount string
    Count of cores of this accelerator.
    Type string
    Type of this accelerator.
    CoreCount string
    Count of cores of this accelerator.
    Type string
    Type of this accelerator.
    coreCount String
    Count of cores of this accelerator.
    type String
    Type of this accelerator.
    coreCount string
    Count of cores of this accelerator.
    type string
    Type of this accelerator.
    core_count str
    Count of cores of this accelerator.
    type str
    Type of this accelerator.
    coreCount String
    Count of cores of this accelerator.
    type String
    Type of this accelerator.

    ContainerImageResponse

    Repository string
    The path to the container image repository. For example: gcr.io/{project_id}/{image_name}
    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}/{image_name}
    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}/{image_name}
    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}/{image_name}
    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}/{image_name}
    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}/{image_name}
    tag String
    The tag of the container image. If not specified, this defaults to the latest tag.

    DiskResponse

    AutoDelete bool
    Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
    Boot bool
    Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
    DeviceName string
    Indicates a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine.This field is only applicable for persistent disks.
    DiskSizeGb string
    Indicates the size of the disk in base-2 GB.
    GuestOsFeatures List<Pulumi.GoogleNative.Notebooks.V1.Inputs.GuestOsFeatureResponse>
    Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
    Index string
    A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
    Interface string
    Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI
    Kind string
    Type of the resource. Always compute#attachedDisk for attached disks.
    Licenses List<string>
    A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.
    Mode string
    The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: * READ_ONLY * READ_WRITE
    Source string
    Indicates a valid partial or full URL to an existing Persistent Disk resource.
    Type string
    Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: * PERSISTENT * SCRATCH
    AutoDelete bool
    Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
    Boot bool
    Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
    DeviceName string
    Indicates a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine.This field is only applicable for persistent disks.
    DiskSizeGb string
    Indicates the size of the disk in base-2 GB.
    GuestOsFeatures []GuestOsFeatureResponse
    Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
    Index string
    A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
    Interface string
    Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI
    Kind string
    Type of the resource. Always compute#attachedDisk for attached disks.
    Licenses []string
    A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.
    Mode string
    The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: * READ_ONLY * READ_WRITE
    Source string
    Indicates a valid partial or full URL to an existing Persistent Disk resource.
    Type string
    Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: * PERSISTENT * SCRATCH
    autoDelete Boolean
    Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
    boot Boolean
    Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
    deviceName String
    Indicates a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine.This field is only applicable for persistent disks.
    diskSizeGb String
    Indicates the size of the disk in base-2 GB.
    guestOsFeatures List<GuestOsFeatureResponse>
    Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
    index String
    A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
    interface_ String
    Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI
    kind String
    Type of the resource. Always compute#attachedDisk for attached disks.
    licenses List<String>
    A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.
    mode String
    The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: * READ_ONLY * READ_WRITE
    source String
    Indicates a valid partial or full URL to an existing Persistent Disk resource.
    type String
    Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: * PERSISTENT * SCRATCH
    autoDelete boolean
    Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
    boot boolean
    Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
    deviceName string
    Indicates a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine.This field is only applicable for persistent disks.
    diskSizeGb string
    Indicates the size of the disk in base-2 GB.
    guestOsFeatures GuestOsFeatureResponse[]
    Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
    index string
    A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
    interface string
    Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI
    kind string
    Type of the resource. Always compute#attachedDisk for attached disks.
    licenses string[]
    A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.
    mode string
    The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: * READ_ONLY * READ_WRITE
    source string
    Indicates a valid partial or full URL to an existing Persistent Disk resource.
    type string
    Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: * PERSISTENT * SCRATCH
    auto_delete bool
    Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
    boot bool
    Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
    device_name str
    Indicates a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine.This field is only applicable for persistent disks.
    disk_size_gb str
    Indicates the size of the disk in base-2 GB.
    guest_os_features Sequence[GuestOsFeatureResponse]
    Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
    index str
    A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
    interface str
    Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI
    kind str
    Type of the resource. Always compute#attachedDisk for attached disks.
    licenses Sequence[str]
    A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.
    mode str
    The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: * READ_ONLY * READ_WRITE
    source str
    Indicates a valid partial or full URL to an existing Persistent Disk resource.
    type str
    Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: * PERSISTENT * SCRATCH
    autoDelete Boolean
    Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
    boot Boolean
    Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
    deviceName String
    Indicates a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine.This field is only applicable for persistent disks.
    diskSizeGb String
    Indicates the size of the disk in base-2 GB.
    guestOsFeatures List<Property Map>
    Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
    index String
    A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
    interface String
    Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI
    kind String
    Type of the resource. Always compute#attachedDisk for attached disks.
    licenses List<String>
    A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.
    mode String
    The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: * READ_ONLY * READ_WRITE
    source String
    Indicates a valid partial or full URL to an existing Persistent Disk resource.
    type String
    Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: * PERSISTENT * SCRATCH

    GuestOsFeatureResponse

    Type string
    The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: * FEATURE_TYPE_UNSPECIFIED * MULTI_IP_SUBNET * SECURE_BOOT * UEFI_COMPATIBLE * VIRTIO_SCSI_MULTIQUEUE * WINDOWS
    Type string
    The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: * FEATURE_TYPE_UNSPECIFIED * MULTI_IP_SUBNET * SECURE_BOOT * UEFI_COMPATIBLE * VIRTIO_SCSI_MULTIQUEUE * WINDOWS
    type String
    The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: * FEATURE_TYPE_UNSPECIFIED * MULTI_IP_SUBNET * SECURE_BOOT * UEFI_COMPATIBLE * VIRTIO_SCSI_MULTIQUEUE * WINDOWS
    type string
    The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: * FEATURE_TYPE_UNSPECIFIED * MULTI_IP_SUBNET * SECURE_BOOT * UEFI_COMPATIBLE * VIRTIO_SCSI_MULTIQUEUE * WINDOWS
    type str
    The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: * FEATURE_TYPE_UNSPECIFIED * MULTI_IP_SUBNET * SECURE_BOOT * UEFI_COMPATIBLE * VIRTIO_SCSI_MULTIQUEUE * WINDOWS
    type String
    The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: * FEATURE_TYPE_UNSPECIFIED * MULTI_IP_SUBNET * SECURE_BOOT * UEFI_COMPATIBLE * VIRTIO_SCSI_MULTIQUEUE * WINDOWS

    InstanceMigrationEligibilityResponse

    Errors List<string>
    Certain configurations make the UmN ineligible for an automatic migration. A manual migration is required.
    Warnings List<string>
    Certain configurations will be defaulted during the migration.
    Errors []string
    Certain configurations make the UmN ineligible for an automatic migration. A manual migration is required.
    Warnings []string
    Certain configurations will be defaulted during the migration.
    errors List<String>
    Certain configurations make the UmN ineligible for an automatic migration. A manual migration is required.
    warnings List<String>
    Certain configurations will be defaulted during the migration.
    errors string[]
    Certain configurations make the UmN ineligible for an automatic migration. A manual migration is required.
    warnings string[]
    Certain configurations will be defaulted during the migration.
    errors Sequence[str]
    Certain configurations make the UmN ineligible for an automatic migration. A manual migration is required.
    warnings Sequence[str]
    Certain configurations will be defaulted during the migration.
    errors List<String>
    Certain configurations make the UmN ineligible for an automatic migration. A manual migration is required.
    warnings List<String>
    Certain configurations will be defaulted during the migration.

    ReservationAffinityResponse

    ConsumeReservationType string
    Optional. Type of reservation to consume
    Key string
    Optional. Corresponds to the label key of reservation resource.
    Values List<string>
    Optional. Corresponds to the label values of reservation resource.
    ConsumeReservationType string
    Optional. Type of reservation to consume
    Key string
    Optional. Corresponds to the label key of reservation resource.
    Values []string
    Optional. Corresponds to the label values of reservation resource.
    consumeReservationType String
    Optional. Type of reservation to consume
    key String
    Optional. Corresponds to the label key of reservation resource.
    values List<String>
    Optional. Corresponds to the label values of reservation resource.
    consumeReservationType string
    Optional. Type of reservation to consume
    key string
    Optional. Corresponds to the label key of reservation resource.
    values string[]
    Optional. Corresponds to the label values of reservation resource.
    consume_reservation_type str
    Optional. Type of reservation to consume
    key str
    Optional. Corresponds to the label key of reservation resource.
    values Sequence[str]
    Optional. Corresponds to the label values of reservation resource.
    consumeReservationType String
    Optional. Type of reservation to consume
    key String
    Optional. Corresponds to the label key of reservation resource.
    values List<String>
    Optional. Corresponds to the label values of reservation resource.

    ShieldedInstanceConfigResponse

    EnableIntegrityMonitoring bool
    Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
    EnableSecureBoot bool
    Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.
    EnableVtpm bool
    Defines whether the instance has the vTPM enabled. Enabled by default.
    EnableIntegrityMonitoring bool
    Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
    EnableSecureBoot bool
    Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.
    EnableVtpm bool
    Defines whether the instance has the vTPM enabled. Enabled by default.
    enableIntegrityMonitoring Boolean
    Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
    enableSecureBoot Boolean
    Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.
    enableVtpm Boolean
    Defines whether the instance has the vTPM enabled. Enabled by default.
    enableIntegrityMonitoring boolean
    Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
    enableSecureBoot boolean
    Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.
    enableVtpm boolean
    Defines whether the instance has the vTPM enabled. Enabled by default.
    enable_integrity_monitoring bool
    Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
    enable_secure_boot bool
    Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.
    enable_vtpm bool
    Defines whether the instance has the vTPM enabled. Enabled by default.
    enableIntegrityMonitoring Boolean
    Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
    enableSecureBoot Boolean
    Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.
    enableVtpm Boolean
    Defines whether the instance has the vTPM enabled. Enabled by default.

    UpgradeHistoryEntryResponse

    Action string
    Action. Rolloback or Upgrade.
    ContainerImage string
    The container image before this instance upgrade.
    CreateTime string
    The time that this instance upgrade history entry is created.
    Framework string
    The framework of this notebook instance.
    Snapshot string
    The snapshot of the boot disk of this notebook instance before upgrade.
    State string
    The state of this instance upgrade history entry.
    TargetImage string
    Target VM Image. Format: ainotebooks-vm/project/image-name/name.
    TargetVersion string
    Target VM Version, like m63.
    Version string
    The version of the notebook instance before this upgrade.
    VmImage string
    The VM image before this instance upgrade.
    Action string
    Action. Rolloback or Upgrade.
    ContainerImage string
    The container image before this instance upgrade.
    CreateTime string
    The time that this instance upgrade history entry is created.
    Framework string
    The framework of this notebook instance.
    Snapshot string
    The snapshot of the boot disk of this notebook instance before upgrade.
    State string
    The state of this instance upgrade history entry.
    TargetImage string
    Target VM Image. Format: ainotebooks-vm/project/image-name/name.
    TargetVersion string
    Target VM Version, like m63.
    Version string
    The version of the notebook instance before this upgrade.
    VmImage string
    The VM image before this instance upgrade.
    action String
    Action. Rolloback or Upgrade.
    containerImage String
    The container image before this instance upgrade.
    createTime String
    The time that this instance upgrade history entry is created.
    framework String
    The framework of this notebook instance.
    snapshot String
    The snapshot of the boot disk of this notebook instance before upgrade.
    state String
    The state of this instance upgrade history entry.
    targetImage String
    Target VM Image. Format: ainotebooks-vm/project/image-name/name.
    targetVersion String
    Target VM Version, like m63.
    version String
    The version of the notebook instance before this upgrade.
    vmImage String
    The VM image before this instance upgrade.
    action string
    Action. Rolloback or Upgrade.
    containerImage string
    The container image before this instance upgrade.
    createTime string
    The time that this instance upgrade history entry is created.
    framework string
    The framework of this notebook instance.
    snapshot string
    The snapshot of the boot disk of this notebook instance before upgrade.
    state string
    The state of this instance upgrade history entry.
    targetImage string
    Target VM Image. Format: ainotebooks-vm/project/image-name/name.
    targetVersion string
    Target VM Version, like m63.
    version string
    The version of the notebook instance before this upgrade.
    vmImage string
    The VM image before this instance upgrade.
    action str
    Action. Rolloback or Upgrade.
    container_image str
    The container image before this instance upgrade.
    create_time str
    The time that this instance upgrade history entry is created.
    framework str
    The framework of this notebook instance.
    snapshot str
    The snapshot of the boot disk of this notebook instance before upgrade.
    state str
    The state of this instance upgrade history entry.
    target_image str
    Target VM Image. Format: ainotebooks-vm/project/image-name/name.
    target_version str
    Target VM Version, like m63.
    version str
    The version of the notebook instance before this upgrade.
    vm_image str
    The VM image before this instance upgrade.
    action String
    Action. Rolloback or Upgrade.
    containerImage String
    The container image before this instance upgrade.
    createTime String
    The time that this instance upgrade history entry is created.
    framework String
    The framework of this notebook instance.
    snapshot String
    The snapshot of the boot disk of this notebook instance before upgrade.
    state String
    The state of this instance upgrade history entry.
    targetImage String
    Target VM Image. Format: ainotebooks-vm/project/image-name/name.
    targetVersion String
    Target VM Version, like m63.
    version String
    The version of the notebook instance before this upgrade.
    vmImage String
    The VM image before this instance upgrade.

    VmImageResponse

    ImageFamily string
    Use this VM image family to find the image; the newest image in this family will be used.
    ImageName string
    Use VM image name to find the image.
    Project string
    The name of the Google Cloud project that this VM image belongs to. Format: {project_id}
    ImageFamily string
    Use this VM image family to find the image; the newest image in this family will be used.
    ImageName string
    Use VM image name to find the image.
    Project string
    The name of the Google Cloud project that this VM image belongs to. Format: {project_id}
    imageFamily String
    Use this VM image family to find the image; the newest image in this family will be used.
    imageName String
    Use VM image name to find the image.
    project String
    The name of the Google Cloud project that this VM image belongs to. Format: {project_id}
    imageFamily string
    Use this VM image family to find the image; the newest image in this family will be used.
    imageName string
    Use VM image name to find the image.
    project string
    The name of the Google Cloud project that this VM image belongs to. Format: {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 str
    The name of the Google Cloud project that this VM image belongs to. Format: {project_id}
    imageFamily String
    Use this VM image family to find the image; the newest image in this family will be used.
    imageName String
    Use VM image name to find the image.
    project String
    The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native