← All packages

Google Cloud (GCP) Classic

Pulumi Official

Package maintained by Pulumi

v6.32.0 published on Wednesday, Jul 20, 2022 by Pulumi

Source code

getInstance

Get information about a VM instance resource within GCE. For more information see the official documentation and API.

Example Usage

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var appserver = Output.Create(Gcp.Compute.GetInstance.InvokeAsync(new Gcp.Compute.GetInstanceArgs
        {
            Name = "primary-application-server",
            Zone = "us-central1-a",
        }));
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.LookupInstance(ctx, &compute.LookupInstanceArgs{
			Name: pulumi.StringRef("primary-application-server"),
			Zone: pulumi.StringRef("us-central1-a"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var appserver = Output.of(ComputeFunctions.getInstance(GetInstanceArgs.builder()
            .name("primary-application-server")
            .zone("us-central1-a")
            .build()));

    }
}

import pulumi
import pulumi_gcp as gcp

appserver = gcp.compute.get_instance(name="primary-application-server",
    zone="us-central1-a")

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

const appserver = pulumi.output(gcp.compute.getInstance({
    name: "primary-application-server",
    zone: "us-central1-a",
}));

variables:
  appserver:
    Fn::Invoke:
      Function: gcp:compute:getInstance
      Arguments:
        name: primary-application-server
        zone: us-central1-a

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(name: Optional[str] = None,
                 project: Optional[str] = None,
                 self_link: Optional[str] = None,
                 zone: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(name: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 self_link: Optional[pulumi.Input[str]] = None,
                 zone: 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: gcp:compute/getInstance:getInstance
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string: The name of the instance. One of name or self_link must be provided.
Project string: The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
SelfLink string: The self link of the instance. One of name or self_link must be provided.
Zone string: The zone of the instance. If self_link is provided, this value is ignored. If neither self_link nor zone are provided, the provider zone is used.

Name string: The name of the instance. One of name or self_link must be provided.
Project string: The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
SelfLink string: The self link of the instance. One of name or self_link must be provided.
Zone string: The zone of the instance. If self_link is provided, this value is ignored. If neither self_link nor zone are provided, the provider zone is used.

name String: The name of the instance. One of name or self_link must be provided.
project String: The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
selfLink String: The self link of the instance. One of name or self_link must be provided.
zone String: The zone of the instance. If self_link is provided, this value is ignored. If neither self_link nor zone are provided, the provider zone is used.

name string: The name of the instance. One of name or self_link must be provided.
project string: The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
selfLink string: The self link of the instance. One of name or self_link must be provided.
zone string: The zone of the instance. If self_link is provided, this value is ignored. If neither self_link nor zone are provided, the provider zone is used.

name str: The name of the instance. One of name or self_link must be provided.
project str: The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
self_link str: The self link of the instance. One of name or self_link must be provided.
zone str: The zone of the instance. If self_link is provided, this value is ignored. If neither self_link nor zone are provided, the provider zone is used.

name String: The name of the instance. One of name or self_link must be provided.
project String: The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
selfLink String: The self link of the instance. One of name or self_link must be provided.
zone String: The zone of the instance. If self_link is provided, this value is ignored. If neither self_link nor zone are provided, the provider zone is used.

getInstance Result

The following output properties are available:

AdvancedMachineFeatures List<GetInstanceAdvancedMachineFeature>
AllowStoppingForUpdate bool
AttachedDisks List<GetInstanceAttachedDisk>: List of disks attached to the instance. Structure is documented below.
BootDisks List<GetInstanceBootDisk>: The boot disk for the instance. Structure is documented below.
CanIpForward bool: Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
ConfidentialInstanceConfigs List<GetInstanceConfidentialInstanceConfig>
CpuPlatform string: The CPU platform used by this instance.
CurrentStatus string
DeletionProtection bool: Whether deletion protection is enabled on this instance.
Description string: A brief description of the resource.
DesiredStatus string
EnableDisplay bool
GuestAccelerators List<GetInstanceGuestAccelerator>: List of the type and count of accelerator cards attached to the instance. Structure is documented below.
Hostname string
Id string: The provider-assigned unique ID for this managed resource.
InstanceId string: The server-assigned unique identifier of this instance.
LabelFingerprint string: The unique fingerprint of the labels.
Labels Dictionary<string, string>: A set of key/value label pairs assigned to the instance.
MachineType string: The machine type to create.
Metadata Dictionary<string, string>: Metadata key/value pairs made available within the instance.
MetadataFingerprint string: The unique fingerprint of the metadata.
MetadataStartupScript string
MinCpuPlatform string: The minimum CPU platform specified for the VM instance.
NetworkInterfaces List<GetInstanceNetworkInterface>: The networks attached to the instance. Structure is documented below.
NetworkPerformanceConfigs List<GetInstanceNetworkPerformanceConfig>: The network performance configuration setting for the instance, if set. Structure is documented below.
ReservationAffinities List<GetInstanceReservationAffinity>
ResourcePolicies List<string>
Schedulings List<GetInstanceScheduling>: The scheduling strategy being used by the instance. Structure is documented below
ScratchDisks List<GetInstanceScratchDisk>: The scratch disks attached to the instance. Structure is documented below.
ServiceAccounts List<GetInstanceServiceAccount>: The service account to attach to the instance. Structure is documented below.
ShieldedInstanceConfigs List<GetInstanceShieldedInstanceConfig>: The shielded vm config being used by the instance. Structure is documented below.
Tags List<string>: The list of tags attached to the instance.
TagsFingerprint string: The unique fingerprint of the tags.
Name string
Project string
SelfLink string: The URI of the created resource.
Zone string

AdvancedMachineFeatures []GetInstanceAdvancedMachineFeature
AllowStoppingForUpdate bool
AttachedDisks []GetInstanceAttachedDisk: List of disks attached to the instance. Structure is documented below.
BootDisks []GetInstanceBootDisk: The boot disk for the instance. Structure is documented below.
CanIpForward bool: Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
ConfidentialInstanceConfigs []GetInstanceConfidentialInstanceConfig
CpuPlatform string: The CPU platform used by this instance.
CurrentStatus string
DeletionProtection bool: Whether deletion protection is enabled on this instance.
Description string: A brief description of the resource.
DesiredStatus string
EnableDisplay bool
GuestAccelerators []GetInstanceGuestAccelerator: List of the type and count of accelerator cards attached to the instance. Structure is documented below.
Hostname string
Id string: The provider-assigned unique ID for this managed resource.
InstanceId string: The server-assigned unique identifier of this instance.
LabelFingerprint string: The unique fingerprint of the labels.
Labels map[string]string: A set of key/value label pairs assigned to the instance.
MachineType string: The machine type to create.
Metadata map[string]string: Metadata key/value pairs made available within the instance.
MetadataFingerprint string: The unique fingerprint of the metadata.
MetadataStartupScript string
MinCpuPlatform string: The minimum CPU platform specified for the VM instance.
NetworkInterfaces []GetInstanceNetworkInterface: The networks attached to the instance. Structure is documented below.
NetworkPerformanceConfigs []GetInstanceNetworkPerformanceConfig: The network performance configuration setting for the instance, if set. Structure is documented below.
ReservationAffinities []GetInstanceReservationAffinity
ResourcePolicies []string
Schedulings []GetInstanceScheduling: The scheduling strategy being used by the instance. Structure is documented below
ScratchDisks []GetInstanceScratchDisk: The scratch disks attached to the instance. Structure is documented below.
ServiceAccounts []GetInstanceServiceAccount: The service account to attach to the instance. Structure is documented below.
ShieldedInstanceConfigs []GetInstanceShieldedInstanceConfig: The shielded vm config being used by the instance. Structure is documented below.
Tags []string: The list of tags attached to the instance.
TagsFingerprint string: The unique fingerprint of the tags.
Name string
Project string
SelfLink string: The URI of the created resource.
Zone string

advancedMachineFeatures List<GetInstanceAdvancedMachineFeature>
allowStoppingForUpdate Boolean
attachedDisks List<GetInstanceAttachedDisk>: List of disks attached to the instance. Structure is documented below.
bootDisks List<GetInstanceBootDisk>: The boot disk for the instance. Structure is documented below.
canIpForward Boolean: Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
confidentialInstanceConfigs List<GetInstanceConfidentialInstanceConfig>
cpuPlatform String: The CPU platform used by this instance.
currentStatus String
deletionProtection Boolean: Whether deletion protection is enabled on this instance.
description String: A brief description of the resource.
desiredStatus String
enableDisplay Boolean
guestAccelerators List<GetInstanceGuestAccelerator>: List of the type and count of accelerator cards attached to the instance. Structure is documented below.
hostname String
id String: The provider-assigned unique ID for this managed resource.
instanceId String: The server-assigned unique identifier of this instance.
labelFingerprint String: The unique fingerprint of the labels.
labels Map<String,String>: A set of key/value label pairs assigned to the instance.
machineType String: The machine type to create.
metadata Map<String,String>: Metadata key/value pairs made available within the instance.
metadataFingerprint String: The unique fingerprint of the metadata.
metadataStartupScript String
minCpuPlatform String: The minimum CPU platform specified for the VM instance.
networkInterfaces List<GetInstanceNetworkInterface>: The networks attached to the instance. Structure is documented below.
networkPerformanceConfigs List<GetInstanceNetworkPerformanceConfig>: The network performance configuration setting for the instance, if set. Structure is documented below.
reservationAffinities List<GetInstanceReservationAffinity>
resourcePolicies List<String>
schedulings List<GetInstanceScheduling>: The scheduling strategy being used by the instance. Structure is documented below
scratchDisks List<GetInstanceScratchDisk>: The scratch disks attached to the instance. Structure is documented below.
serviceAccounts List<GetInstanceServiceAccount>: The service account to attach to the instance. Structure is documented below.
shieldedInstanceConfigs List<GetInstanceShieldedInstanceConfig>: The shielded vm config being used by the instance. Structure is documented below.
tags List<String>: The list of tags attached to the instance.
tagsFingerprint String: The unique fingerprint of the tags.
name String
project String
selfLink String: The URI of the created resource.
zone String

advancedMachineFeatures GetInstanceAdvancedMachineFeature[]
allowStoppingForUpdate boolean
attachedDisks GetInstanceAttachedDisk[]: List of disks attached to the instance. Structure is documented below.
bootDisks GetInstanceBootDisk[]: The boot disk for the instance. Structure is documented below.
canIpForward boolean: Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
confidentialInstanceConfigs GetInstanceConfidentialInstanceConfig[]
cpuPlatform string: The CPU platform used by this instance.
currentStatus string
deletionProtection boolean: Whether deletion protection is enabled on this instance.
description string: A brief description of the resource.
desiredStatus string
enableDisplay boolean
guestAccelerators GetInstanceGuestAccelerator[]: List of the type and count of accelerator cards attached to the instance. Structure is documented below.
hostname string
id string: The provider-assigned unique ID for this managed resource.
instanceId string: The server-assigned unique identifier of this instance.
labelFingerprint string: The unique fingerprint of the labels.
labels {[key: string]: string}: A set of key/value label pairs assigned to the instance.
machineType string: The machine type to create.
metadata {[key: string]: string}: Metadata key/value pairs made available within the instance.
metadataFingerprint string: The unique fingerprint of the metadata.
metadataStartupScript string
minCpuPlatform string: The minimum CPU platform specified for the VM instance.
networkInterfaces GetInstanceNetworkInterface[]: The networks attached to the instance. Structure is documented below.
networkPerformanceConfigs GetInstanceNetworkPerformanceConfig[]: The network performance configuration setting for the instance, if set. Structure is documented below.
reservationAffinities GetInstanceReservationAffinity[]
resourcePolicies string[]
schedulings GetInstanceScheduling[]: The scheduling strategy being used by the instance. Structure is documented below
scratchDisks GetInstanceScratchDisk[]: The scratch disks attached to the instance. Structure is documented below.
serviceAccounts GetInstanceServiceAccount[]: The service account to attach to the instance. Structure is documented below.
shieldedInstanceConfigs GetInstanceShieldedInstanceConfig[]: The shielded vm config being used by the instance. Structure is documented below.
tags string[]: The list of tags attached to the instance.
tagsFingerprint string: The unique fingerprint of the tags.
name string
project string
selfLink string: The URI of the created resource.
zone string

advanced_machine_features Sequence[GetInstanceAdvancedMachineFeature]
allow_stopping_for_update bool
attached_disks Sequence[GetInstanceAttachedDisk]: List of disks attached to the instance. Structure is documented below.
boot_disks Sequence[GetInstanceBootDisk]: The boot disk for the instance. Structure is documented below.
can_ip_forward bool: Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
confidential_instance_configs Sequence[GetInstanceConfidentialInstanceConfig]
cpu_platform str: The CPU platform used by this instance.
current_status str
deletion_protection bool: Whether deletion protection is enabled on this instance.
description str: A brief description of the resource.
desired_status str
enable_display bool
guest_accelerators Sequence[GetInstanceGuestAccelerator]: List of the type and count of accelerator cards attached to the instance. Structure is documented below.
hostname str
id str: The provider-assigned unique ID for this managed resource.
instance_id str: The server-assigned unique identifier of this instance.
label_fingerprint str: The unique fingerprint of the labels.
labels Mapping[str, str]: A set of key/value label pairs assigned to the instance.
machine_type str: The machine type to create.
metadata Mapping[str, str]: Metadata key/value pairs made available within the instance.
metadata_fingerprint str: The unique fingerprint of the metadata.
metadata_startup_script str
min_cpu_platform str: The minimum CPU platform specified for the VM instance.
network_interfaces Sequence[GetInstanceNetworkInterface]: The networks attached to the instance. Structure is documented below.
network_performance_configs Sequence[GetInstanceNetworkPerformanceConfig]: The network performance configuration setting for the instance, if set. Structure is documented below.
reservation_affinities Sequence[GetInstanceReservationAffinity]
resource_policies Sequence[str]
schedulings Sequence[GetInstanceScheduling]: The scheduling strategy being used by the instance. Structure is documented below
scratch_disks Sequence[GetInstanceScratchDisk]: The scratch disks attached to the instance. Structure is documented below.
service_accounts Sequence[GetInstanceServiceAccount]: The service account to attach to the instance. Structure is documented below.
shielded_instance_configs Sequence[GetInstanceShieldedInstanceConfig]: The shielded vm config being used by the instance. Structure is documented below.
tags Sequence[str]: The list of tags attached to the instance.
tags_fingerprint str: The unique fingerprint of the tags.
name str
project str
self_link str: The URI of the created resource.
zone str

advancedMachineFeatures List<Property Map>
allowStoppingForUpdate Boolean
attachedDisks List<Property Map>: List of disks attached to the instance. Structure is documented below.
bootDisks List<Property Map>: The boot disk for the instance. Structure is documented below.
canIpForward Boolean: Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
confidentialInstanceConfigs List<Property Map>
cpuPlatform String: The CPU platform used by this instance.
currentStatus String
deletionProtection Boolean: Whether deletion protection is enabled on this instance.
description String: A brief description of the resource.
desiredStatus String
enableDisplay Boolean
guestAccelerators List<Property Map>: List of the type and count of accelerator cards attached to the instance. Structure is documented below.
hostname String
id String: The provider-assigned unique ID for this managed resource.
instanceId String: The server-assigned unique identifier of this instance.
labelFingerprint String: The unique fingerprint of the labels.
labels Map<String>: A set of key/value label pairs assigned to the instance.
machineType String: The machine type to create.
metadata Map<String>: Metadata key/value pairs made available within the instance.
metadataFingerprint String: The unique fingerprint of the metadata.
metadataStartupScript String
minCpuPlatform String: The minimum CPU platform specified for the VM instance.
networkInterfaces List<Property Map>: The networks attached to the instance. Structure is documented below.
networkPerformanceConfigs List<Property Map>: The network performance configuration setting for the instance, if set. Structure is documented below.
reservationAffinities List<Property Map>
resourcePolicies List<String>
schedulings List<Property Map>: The scheduling strategy being used by the instance. Structure is documented below
scratchDisks List<Property Map>: The scratch disks attached to the instance. Structure is documented below.
serviceAccounts List<Property Map>: The service account to attach to the instance. Structure is documented below.
shieldedInstanceConfigs List<Property Map>: The shielded vm config being used by the instance. Structure is documented below.
tags List<String>: The list of tags attached to the instance.
tagsFingerprint String: The unique fingerprint of the tags.
name String
project String
selfLink String: The URI of the created resource.
zone String

Supporting Types

EnableNestedVirtualization bool
ThreadsPerCore int

enableNestedVirtualization Boolean
threadsPerCore Integer

enableNestedVirtualization boolean
threadsPerCore number

enable_nested_virtualization bool
threads_per_core int

enableNestedVirtualization Boolean
threadsPerCore Number

GetInstanceAttachedDisk

DeviceName string: Name with which the attached disk is accessible under /dev/disk/by-id/
DiskEncryptionKeyRaw string
DiskEncryptionKeySha256 string
KmsKeySelfLink string
Mode string: Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".
Source string: The name or self_link of the disk attached to this instance.

DeviceName string: Name with which the attached disk is accessible under /dev/disk/by-id/
DiskEncryptionKeyRaw string
DiskEncryptionKeySha256 string
KmsKeySelfLink string
Mode string: Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".
Source string: The name or self_link of the disk attached to this instance.

deviceName String: Name with which the attached disk is accessible under /dev/disk/by-id/
diskEncryptionKeyRaw String
diskEncryptionKeySha256 String
kmsKeySelfLink String
mode String: Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".
source String: The name or self_link of the disk attached to this instance.

deviceName string: Name with which the attached disk is accessible under /dev/disk/by-id/
diskEncryptionKeyRaw string
diskEncryptionKeySha256 string
kmsKeySelfLink string
mode string: Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".
source string: The name or self_link of the disk attached to this instance.

device_name str: Name with which the attached disk is accessible under /dev/disk/by-id/
disk_encryption_key_raw str
disk_encryption_key_sha256 str
kms_key_self_link str
mode str: Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".
source str: The name or self_link of the disk attached to this instance.

deviceName String: Name with which the attached disk is accessible under /dev/disk/by-id/
diskEncryptionKeyRaw String
diskEncryptionKeySha256 String
kmsKeySelfLink String
mode String: Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".
source String: The name or self_link of the disk attached to this instance.

GetInstanceBootDisk

AutoDelete bool: Whether the disk will be auto-deleted when the instance is deleted.
DeviceName string: Name with which the attached disk is accessible under /dev/disk/by-id/
DiskEncryptionKeyRaw string
DiskEncryptionKeySha256 string
InitializeParams List<GetInstanceBootDiskInitializeParam>: Parameters with which a disk was created alongside the instance. Structure is documented below.
KmsKeySelfLink string
Mode string: Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".
Source string: The name or self_link of the disk attached to this instance.

AutoDelete bool: Whether the disk will be auto-deleted when the instance is deleted.
DeviceName string: Name with which the attached disk is accessible under /dev/disk/by-id/
DiskEncryptionKeyRaw string
DiskEncryptionKeySha256 string
InitializeParams []GetInstanceBootDiskInitializeParam: Parameters with which a disk was created alongside the instance. Structure is documented below.
KmsKeySelfLink string
Mode string: Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".
Source string: The name or self_link of the disk attached to this instance.

autoDelete Boolean: Whether the disk will be auto-deleted when the instance is deleted.
deviceName String: Name with which the attached disk is accessible under /dev/disk/by-id/
diskEncryptionKeyRaw String
diskEncryptionKeySha256 String
initializeParams List<GetInstanceBootDiskInitializeParam>: Parameters with which a disk was created alongside the instance. Structure is documented below.
kmsKeySelfLink String
mode String: Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".
source String: The name or self_link of the disk attached to this instance.

autoDelete boolean: Whether the disk will be auto-deleted when the instance is deleted.
deviceName string: Name with which the attached disk is accessible under /dev/disk/by-id/
diskEncryptionKeyRaw string
diskEncryptionKeySha256 string
initializeParams GetInstanceBootDiskInitializeParam[]: Parameters with which a disk was created alongside the instance. Structure is documented below.
kmsKeySelfLink string
mode string: Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".
source string: The name or self_link of the disk attached to this instance.

auto_delete bool: Whether the disk will be auto-deleted when the instance is deleted.
device_name str: Name with which the attached disk is accessible under /dev/disk/by-id/
disk_encryption_key_raw str
disk_encryption_key_sha256 str
initialize_params Sequence[GetInstanceBootDiskInitializeParam]: Parameters with which a disk was created alongside the instance. Structure is documented below.
kms_key_self_link str
mode str: Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".
source str: The name or self_link of the disk attached to this instance.

autoDelete Boolean: Whether the disk will be auto-deleted when the instance is deleted.
deviceName String: Name with which the attached disk is accessible under /dev/disk/by-id/
diskEncryptionKeyRaw String
diskEncryptionKeySha256 String
initializeParams List<Property Map>: Parameters with which a disk was created alongside the instance. Structure is documented below.
kmsKeySelfLink String
mode String: Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".
source String: The name or self_link of the disk attached to this instance.

GetInstanceBootDiskInitializeParam

Image string: The image from which this disk was initialised.
Labels Dictionary<string, object>: A set of key/value label pairs assigned to the instance.
Size int: The size of the image in gigabytes.
Type string: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

Image string: The image from which this disk was initialised.
Labels map[string]interface{}: A set of key/value label pairs assigned to the instance.
Size int: The size of the image in gigabytes.
Type string: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

image String: The image from which this disk was initialised.
labels Map<String,Object>: A set of key/value label pairs assigned to the instance.
size Integer: The size of the image in gigabytes.
type String: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

image string: The image from which this disk was initialised.
labels {[key: string]: any}: A set of key/value label pairs assigned to the instance.
size number: The size of the image in gigabytes.
type string: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

image str: The image from which this disk was initialised.
labels Mapping[str, Any]: A set of key/value label pairs assigned to the instance.
size int: The size of the image in gigabytes.
type str: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

image String: The image from which this disk was initialised.
labels Map<Any>: A set of key/value label pairs assigned to the instance.
size Number: The size of the image in gigabytes.
type String: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

GetInstanceConfidentialInstanceConfig

EnableConfidentialCompute bool

EnableConfidentialCompute bool

enableConfidentialCompute Boolean

enableConfidentialCompute boolean

enable_confidential_compute bool

enableConfidentialCompute Boolean

GetInstanceGuestAccelerator

Count int: The number of the guest accelerator cards exposed to this instance.
Type string: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

Count int: The number of the guest accelerator cards exposed to this instance.
Type string: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

count Integer: The number of the guest accelerator cards exposed to this instance.
type String: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

count number: The number of the guest accelerator cards exposed to this instance.
type string: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

count int: The number of the guest accelerator cards exposed to this instance.
type str: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

count Number: The number of the guest accelerator cards exposed to this instance.
type String: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

GetInstanceNetworkInterface

AccessConfigs List<GetInstanceNetworkInterfaceAccessConfig>: Access configurations, i.e. IPs via which this instance can be accessed via the Internet. Structure documented below.
AliasIpRanges List<GetInstanceNetworkInterfaceAliasIpRange>: An array of alias IP ranges for this network interface. Structure documented below.
Ipv6AccessConfigs List<GetInstanceNetworkInterfaceIpv6AccessConfig>
Ipv6AccessType string
Name string: The name of the instance. One of name or self_link must be provided.
Network string: The name or self_link of the network attached to this interface.
NetworkIp string: The private IP address assigned to the instance.
NicType string
QueueCount int
StackType string
Subnetwork string: The name or self_link of the subnetwork attached to this interface.
SubnetworkProject string: The project in which the subnetwork belongs.

AccessConfigs []GetInstanceNetworkInterfaceAccessConfig: Access configurations, i.e. IPs via which this instance can be accessed via the Internet. Structure documented below.
AliasIpRanges []GetInstanceNetworkInterfaceAliasIpRange: An array of alias IP ranges for this network interface. Structure documented below.
Ipv6AccessConfigs []GetInstanceNetworkInterfaceIpv6AccessConfig
Ipv6AccessType string
Name string: The name of the instance. One of name or self_link must be provided.
Network string: The name or self_link of the network attached to this interface.
NetworkIp string: The private IP address assigned to the instance.
NicType string
QueueCount int
StackType string
Subnetwork string: The name or self_link of the subnetwork attached to this interface.
SubnetworkProject string: The project in which the subnetwork belongs.

accessConfigs List<GetInstanceNetworkInterfaceAccessConfig>: Access configurations, i.e. IPs via which this instance can be accessed via the Internet. Structure documented below.
aliasIpRanges List<GetInstanceNetworkInterfaceAliasIpRange>: An array of alias IP ranges for this network interface. Structure documented below.
ipv6AccessConfigs List<GetInstanceNetworkInterfaceIpv6AccessConfig>
ipv6AccessType String
name String: The name of the instance. One of name or self_link must be provided.
network String: The name or self_link of the network attached to this interface.
networkIp String: The private IP address assigned to the instance.
nicType String
queueCount Integer
stackType String
subnetwork String: The name or self_link of the subnetwork attached to this interface.
subnetworkProject String: The project in which the subnetwork belongs.

accessConfigs GetInstanceNetworkInterfaceAccessConfig[]: Access configurations, i.e. IPs via which this instance can be accessed via the Internet. Structure documented below.
aliasIpRanges GetInstanceNetworkInterfaceAliasIpRange[]: An array of alias IP ranges for this network interface. Structure documented below.
ipv6AccessConfigs GetInstanceNetworkInterfaceIpv6AccessConfig[]
ipv6AccessType string
name string: The name of the instance. One of name or self_link must be provided.
network string: The name or self_link of the network attached to this interface.
networkIp string: The private IP address assigned to the instance.
nicType string
queueCount number
stackType string
subnetwork string: The name or self_link of the subnetwork attached to this interface.
subnetworkProject string: The project in which the subnetwork belongs.

access_configs Sequence[GetInstanceNetworkInterfaceAccessConfig]: Access configurations, i.e. IPs via which this instance can be accessed via the Internet. Structure documented below.
alias_ip_ranges Sequence[GetInstanceNetworkInterfaceAliasIpRange]: An array of alias IP ranges for this network interface. Structure documented below.
ipv6_access_configs Sequence[GetInstanceNetworkInterfaceIpv6AccessConfig]
ipv6_access_type str
name str: The name of the instance. One of name or self_link must be provided.
network str: The name or self_link of the network attached to this interface.
network_ip str: The private IP address assigned to the instance.
nic_type str
queue_count int
stack_type str
subnetwork str: The name or self_link of the subnetwork attached to this interface.
subnetwork_project str: The project in which the subnetwork belongs.

accessConfigs List<Property Map>: Access configurations, i.e. IPs via which this instance can be accessed via the Internet. Structure documented below.
aliasIpRanges List<Property Map>: An array of alias IP ranges for this network interface. Structure documented below.
ipv6AccessConfigs List<Property Map>
ipv6AccessType String
name String: The name of the instance. One of name or self_link must be provided.
network String: The name or self_link of the network attached to this interface.
networkIp String: The private IP address assigned to the instance.
nicType String
queueCount Number
stackType String
subnetwork String: The name or self_link of the subnetwork attached to this interface.
subnetworkProject String: The project in which the subnetwork belongs.

GetInstanceNetworkInterfaceAccessConfig

NatIp string: The IP address that is be 1:1 mapped to the instance's network ip.
NetworkTier string: The [networking tier][network-tier] used for configuring this instance. One of PREMIUM or STANDARD.
PublicPtrDomainName string: The DNS domain name for the public PTR record.

NatIp string: The IP address that is be 1:1 mapped to the instance's network ip.
NetworkTier string: The [networking tier][network-tier] used for configuring this instance. One of PREMIUM or STANDARD.
PublicPtrDomainName string: The DNS domain name for the public PTR record.

natIp String: The IP address that is be 1:1 mapped to the instance's network ip.
networkTier String: The [networking tier][network-tier] used for configuring this instance. One of PREMIUM or STANDARD.
publicPtrDomainName String: The DNS domain name for the public PTR record.

natIp string: The IP address that is be 1:1 mapped to the instance's network ip.
networkTier string: The [networking tier][network-tier] used for configuring this instance. One of PREMIUM or STANDARD.
publicPtrDomainName string: The DNS domain name for the public PTR record.

nat_ip str: The IP address that is be 1:1 mapped to the instance's network ip.
network_tier str: The [networking tier][network-tier] used for configuring this instance. One of PREMIUM or STANDARD.
public_ptr_domain_name str: The DNS domain name for the public PTR record.

natIp String: The IP address that is be 1:1 mapped to the instance's network ip.
networkTier String: The [networking tier][network-tier] used for configuring this instance. One of PREMIUM or STANDARD.
publicPtrDomainName String: The DNS domain name for the public PTR record.

GetInstanceNetworkInterfaceAliasIpRange

IpCidrRange string: The IP CIDR range represented by this alias IP range.
SubnetworkRangeName string: The subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range.

IpCidrRange string: The IP CIDR range represented by this alias IP range.
SubnetworkRangeName string: The subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range.

ipCidrRange String: The IP CIDR range represented by this alias IP range.
subnetworkRangeName String: The subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range.

ipCidrRange string: The IP CIDR range represented by this alias IP range.
subnetworkRangeName string: The subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range.

ip_cidr_range str: The IP CIDR range represented by this alias IP range.
subnetwork_range_name str: The subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range.

ipCidrRange String: The IP CIDR range represented by this alias IP range.
subnetworkRangeName String: The subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range.

GetInstanceNetworkInterfaceIpv6AccessConfig

ExternalIpv6 string
ExternalIpv6PrefixLength string
NetworkTier string: The [networking tier][network-tier] used for configuring this instance. One of PREMIUM or STANDARD.
PublicPtrDomainName string: The DNS domain name for the public PTR record.

ExternalIpv6 string
ExternalIpv6PrefixLength string
NetworkTier string: The [networking tier][network-tier] used for configuring this instance. One of PREMIUM or STANDARD.
PublicPtrDomainName string: The DNS domain name for the public PTR record.

externalIpv6 String
externalIpv6PrefixLength String
networkTier String: The [networking tier][network-tier] used for configuring this instance. One of PREMIUM or STANDARD.
publicPtrDomainName String: The DNS domain name for the public PTR record.

externalIpv6 string
externalIpv6PrefixLength string
networkTier string: The [networking tier][network-tier] used for configuring this instance. One of PREMIUM or STANDARD.
publicPtrDomainName string: The DNS domain name for the public PTR record.

external_ipv6 str
external_ipv6_prefix_length str
network_tier str: The [networking tier][network-tier] used for configuring this instance. One of PREMIUM or STANDARD.
public_ptr_domain_name str: The DNS domain name for the public PTR record.

externalIpv6 String
externalIpv6PrefixLength String
networkTier String: The [networking tier][network-tier] used for configuring this instance. One of PREMIUM or STANDARD.
publicPtrDomainName String: The DNS domain name for the public PTR record.

GetInstanceNetworkPerformanceConfig

TotalEgressBandwidthTier string: The egress bandwidth tier for the instance.

TotalEgressBandwidthTier string: The egress bandwidth tier for the instance.

totalEgressBandwidthTier String: The egress bandwidth tier for the instance.

totalEgressBandwidthTier string: The egress bandwidth tier for the instance.

total_egress_bandwidth_tier str: The egress bandwidth tier for the instance.

totalEgressBandwidthTier String: The egress bandwidth tier for the instance.

GetInstanceReservationAffinity

SpecificReservations List<GetInstanceReservationAffinitySpecificReservation>
Type string: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

SpecificReservations []GetInstanceReservationAffinitySpecificReservation
Type string: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

specificReservations List<GetInstanceReservationAffinitySpecificReservation>
type String: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

specificReservations GetInstanceReservationAffinitySpecificReservation[]
type string: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

specific_reservations Sequence[GetInstanceReservationAffinitySpecificReservation]
type str: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

specificReservations List<Property Map>
type String: The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

GetInstanceReservationAffinitySpecificReservation

Key string
Values List<string>

Key string
Values []string

key String
values List<String>

key string
values string[]

key str
values Sequence[str]

key String
values List<String>

GetInstanceScheduling

AutomaticRestart bool: Specifies if the instance should be restarted if it was terminated by Compute Engine (not a user).
MinNodeCpus int
NodeAffinities List<GetInstanceSchedulingNodeAffinity>
OnHostMaintenance string: Describes maintenance behavior for the instance. One of MIGRATE or TERMINATE, for more info, read here
Preemptible bool: Whether the instance is preemptible.
ProvisioningModel string: (Beta) Describe the type of preemptible VM.

AutomaticRestart bool: Specifies if the instance should be restarted if it was terminated by Compute Engine (not a user).
MinNodeCpus int
NodeAffinities []GetInstanceSchedulingNodeAffinity
OnHostMaintenance string: Describes maintenance behavior for the instance. One of MIGRATE or TERMINATE, for more info, read here
Preemptible bool: Whether the instance is preemptible.
ProvisioningModel string: (Beta) Describe the type of preemptible VM.

automaticRestart Boolean: Specifies if the instance should be restarted if it was terminated by Compute Engine (not a user).
minNodeCpus Integer
nodeAffinities List<GetInstanceSchedulingNodeAffinity>
onHostMaintenance String: Describes maintenance behavior for the instance. One of MIGRATE or TERMINATE, for more info, read here
preemptible Boolean: Whether the instance is preemptible.
provisioningModel String: (Beta) Describe the type of preemptible VM.

automaticRestart boolean: Specifies if the instance should be restarted if it was terminated by Compute Engine (not a user).
minNodeCpus number
nodeAffinities GetInstanceSchedulingNodeAffinity[]
onHostMaintenance string: Describes maintenance behavior for the instance. One of MIGRATE or TERMINATE, for more info, read here
preemptible boolean: Whether the instance is preemptible.
provisioningModel string: (Beta) Describe the type of preemptible VM.

automatic_restart bool: Specifies if the instance should be restarted if it was terminated by Compute Engine (not a user).
min_node_cpus int
node_affinities Sequence[GetInstanceSchedulingNodeAffinity]
on_host_maintenance str: Describes maintenance behavior for the instance. One of MIGRATE or TERMINATE, for more info, read here
preemptible bool: Whether the instance is preemptible.
provisioning_model str: (Beta) Describe the type of preemptible VM.

automaticRestart Boolean: Specifies if the instance should be restarted if it was terminated by Compute Engine (not a user).
minNodeCpus Number
nodeAffinities List<Property Map>
onHostMaintenance String: Describes maintenance behavior for the instance. One of MIGRATE or TERMINATE, for more info, read here
preemptible Boolean: Whether the instance is preemptible.
provisioningModel String: (Beta) Describe the type of preemptible VM.

GetInstanceSchedulingNodeAffinity

Key string
Operator string
Values List<string>

Key string
Operator string
Values []string

key String
operator String
values List<String>

key string
operator string
values string[]

key str
operator str
values Sequence[str]

key String
operator String
values List<String>

GetInstanceScratchDisk

Interface string: The disk interface used for attaching this disk. One of SCSI or NVME.

Interface string: The disk interface used for attaching this disk. One of SCSI or NVME.

interface_ String: The disk interface used for attaching this disk. One of SCSI or NVME.

interface string: The disk interface used for attaching this disk. One of SCSI or NVME.

interface str: The disk interface used for attaching this disk. One of SCSI or NVME.

interface String: The disk interface used for attaching this disk. One of SCSI or NVME.

GetInstanceServiceAccount

Email string: The service account e-mail address.
Scopes List<string>: A list of service scopes.

Email string: The service account e-mail address.
Scopes []string: A list of service scopes.

email String: The service account e-mail address.
scopes List<String>: A list of service scopes.

email string: The service account e-mail address.
scopes string[]: A list of service scopes.

email str: The service account e-mail address.
scopes Sequence[str]: A list of service scopes.

email String: The service account e-mail address.
scopes List<String>: A list of service scopes.

GetInstanceShieldedInstanceConfig

EnableIntegrityMonitoring bool
EnableSecureBoot bool
EnableVtpm bool

EnableIntegrityMonitoring bool
EnableSecureBoot bool
EnableVtpm bool

enableIntegrityMonitoring Boolean
enableSecureBoot Boolean
enableVtpm Boolean

enableIntegrityMonitoring boolean
enableSecureBoot boolean
enableVtpm boolean

enable_integrity_monitoring bool
enable_secure_boot bool
enable_vtpm bool

enableIntegrityMonitoring Boolean
enableSecureBoot Boolean
enableVtpm Boolean

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.