getInstance

Google Cloud v9.14.0, Mar 3 26

Viewing docs for Google Cloud v9.14.0
published on Tuesday, Mar 3, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gcp

Viewing docs for Google Cloud v9.14.0
published on Tuesday, Mar 3, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gcp

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

variables:
  instance:
    fn::invoke:
      function: gcp:lustre:getInstance
      arguments:
        name: my-instance
        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(instance_id: Optional[str] = None,
                 project: Optional[str] = None,
                 zone: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                 project: 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)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

fn::invoke:
  function: gcp:lustre/getInstance:getInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string: The instance id of the Lustre instance.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Zone string: The ID of the zone in which the resource belongs. If it is not provided, the provider zone is used.

InstanceId string: The instance id of the Lustre instance.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Zone string: The ID of the zone in which the resource belongs. If it is not provided, the provider zone is used.

instanceId String: The instance id of the Lustre instance.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zone String: The ID of the zone in which the resource belongs. If it is not provided, the provider zone is used.

instanceId string: The instance id of the Lustre instance.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zone string: The ID of the zone in which the resource belongs. If it is not provided, the provider zone is used.

instance_id str: The instance id of the Lustre instance.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zone str: The ID of the zone in which the resource belongs. If it is not provided, the provider zone is used.

instanceId String: The instance id of the Lustre instance.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zone String: The ID of the zone in which the resource belongs. If it is not provided, the provider zone is used.

getInstance Result

The following output properties are available:

AccessRulesOptions List<GetInstanceAccessRulesOption>
CapacityGib string
CreateTime string
Description string
EffectiveLabels Dictionary<string, string>
Filesystem string
GkeSupportEnabled bool
Id string: The provider-assigned unique ID for this managed resource.
InstanceId string
KmsKey string
Labels Dictionary<string, string>
Location string
MountPoint string
Name string
Network string
PerUnitStorageThroughput string
PlacementPolicy string
PulumiLabels Dictionary<string, string>
State string
StateReason string
UpdateTime string
Project string
Zone string

AccessRulesOptions []GetInstanceAccessRulesOption
CapacityGib string
CreateTime string
Description string
EffectiveLabels map[string]string
Filesystem string
GkeSupportEnabled bool
Id string: The provider-assigned unique ID for this managed resource.
InstanceId string
KmsKey string
Labels map[string]string
Location string
MountPoint string
Name string
Network string
PerUnitStorageThroughput string
PlacementPolicy string
PulumiLabels map[string]string
State string
StateReason string
UpdateTime string
Project string
Zone string

accessRulesOptions List<GetInstanceAccessRulesOption>
capacityGib String
createTime String
description String
effectiveLabels Map<String,String>
filesystem String
gkeSupportEnabled Boolean
id String: The provider-assigned unique ID for this managed resource.
instanceId String
kmsKey String
labels Map<String,String>
location String
mountPoint String
name String
network String
perUnitStorageThroughput String
placementPolicy String
pulumiLabels Map<String,String>
state String
stateReason String
updateTime String
project String
zone String

accessRulesOptions GetInstanceAccessRulesOption[]
capacityGib string
createTime string
description string
effectiveLabels {[key: string]: string}
filesystem string
gkeSupportEnabled boolean
id string: The provider-assigned unique ID for this managed resource.
instanceId string
kmsKey string
labels {[key: string]: string}
location string
mountPoint string
name string
network string
perUnitStorageThroughput string
placementPolicy string
pulumiLabels {[key: string]: string}
state string
stateReason string
updateTime string
project string
zone string

access_rules_options Sequence[GetInstanceAccessRulesOption]
capacity_gib str
create_time str
description str
effective_labels Mapping[str, str]
filesystem str
gke_support_enabled bool
id str: The provider-assigned unique ID for this managed resource.
instance_id str
kms_key str
labels Mapping[str, str]
location str
mount_point str
name str
network str
per_unit_storage_throughput str
placement_policy str
pulumi_labels Mapping[str, str]
state str
state_reason str
update_time str
project str
zone str

accessRulesOptions List<Property Map>
capacityGib String
createTime String
description String
effectiveLabels Map<String>
filesystem String
gkeSupportEnabled Boolean
id String: The provider-assigned unique ID for this managed resource.
instanceId String
kmsKey String
labels Map<String>
location String
mountPoint String
name String
network String
perUnitStorageThroughput String
placementPolicy String
pulumiLabels Map<String>
state String
stateReason String
updateTime String
project String
zone String

Supporting Types

GetInstanceAccessRulesOption

AccessRules List<GetInstanceAccessRulesOptionAccessRule>: An array of access rule exceptions. Each rule defines IP address ranges that should have different squash behavior than the default.
DefaultSquashGid int: The GID to map the root user to when root squashing is enabled (e.g., 65534 for nobody).
DefaultSquashMode string: Set to "ROOT_SQUASH" to enable root squashing by default. Other values include "NO_SQUASH". Possible values: ["ROOT_SQUASH", "NO_SQUASH"]
DefaultSquashUid int: The UID to map the root user to when root squashing is enabled (e.g., 65534 for nobody).

AccessRules []GetInstanceAccessRulesOptionAccessRule: An array of access rule exceptions. Each rule defines IP address ranges that should have different squash behavior than the default.
DefaultSquashGid int: The GID to map the root user to when root squashing is enabled (e.g., 65534 for nobody).
DefaultSquashMode string: Set to "ROOT_SQUASH" to enable root squashing by default. Other values include "NO_SQUASH". Possible values: ["ROOT_SQUASH", "NO_SQUASH"]
DefaultSquashUid int: The UID to map the root user to when root squashing is enabled (e.g., 65534 for nobody).

accessRules List<GetInstanceAccessRulesOptionAccessRule>: An array of access rule exceptions. Each rule defines IP address ranges that should have different squash behavior than the default.
defaultSquashGid Integer: The GID to map the root user to when root squashing is enabled (e.g., 65534 for nobody).
defaultSquashMode String: Set to "ROOT_SQUASH" to enable root squashing by default. Other values include "NO_SQUASH". Possible values: ["ROOT_SQUASH", "NO_SQUASH"]
defaultSquashUid Integer: The UID to map the root user to when root squashing is enabled (e.g., 65534 for nobody).

accessRules GetInstanceAccessRulesOptionAccessRule[]: An array of access rule exceptions. Each rule defines IP address ranges that should have different squash behavior than the default.
defaultSquashGid number: The GID to map the root user to when root squashing is enabled (e.g., 65534 for nobody).
defaultSquashMode string: Set to "ROOT_SQUASH" to enable root squashing by default. Other values include "NO_SQUASH". Possible values: ["ROOT_SQUASH", "NO_SQUASH"]
defaultSquashUid number: The UID to map the root user to when root squashing is enabled (e.g., 65534 for nobody).

access_rules Sequence[GetInstanceAccessRulesOptionAccessRule]: An array of access rule exceptions. Each rule defines IP address ranges that should have different squash behavior than the default.
default_squash_gid int: The GID to map the root user to when root squashing is enabled (e.g., 65534 for nobody).
default_squash_mode str: Set to "ROOT_SQUASH" to enable root squashing by default. Other values include "NO_SQUASH". Possible values: ["ROOT_SQUASH", "NO_SQUASH"]
default_squash_uid int: The UID to map the root user to when root squashing is enabled (e.g., 65534 for nobody).

accessRules List<Property Map>: An array of access rule exceptions. Each rule defines IP address ranges that should have different squash behavior than the default.
defaultSquashGid Number: The GID to map the root user to when root squashing is enabled (e.g., 65534 for nobody).
defaultSquashMode String: Set to "ROOT_SQUASH" to enable root squashing by default. Other values include "NO_SQUASH". Possible values: ["ROOT_SQUASH", "NO_SQUASH"]
defaultSquashUid Number: The UID to map the root user to when root squashing is enabled (e.g., 65534 for nobody).

GetInstanceAccessRulesOptionAccessRule

IpAddressRanges List<string>: An array of IP address strings or CIDR ranges that this rule applies to.
Name string: A unique identifier for the access rule.
SquashMode string: The squash mode for this specific rule. Currently, only "NO_SQUASH" is supported for exceptions. Possible values: ["NO_SQUASH"]

IpAddressRanges []string: An array of IP address strings or CIDR ranges that this rule applies to.
Name string: A unique identifier for the access rule.
SquashMode string: The squash mode for this specific rule. Currently, only "NO_SQUASH" is supported for exceptions. Possible values: ["NO_SQUASH"]

ipAddressRanges List<String>: An array of IP address strings or CIDR ranges that this rule applies to.
name String: A unique identifier for the access rule.
squashMode String: The squash mode for this specific rule. Currently, only "NO_SQUASH" is supported for exceptions. Possible values: ["NO_SQUASH"]

ipAddressRanges string[]: An array of IP address strings or CIDR ranges that this rule applies to.
name string: A unique identifier for the access rule.
squashMode string: The squash mode for this specific rule. Currently, only "NO_SQUASH" is supported for exceptions. Possible values: ["NO_SQUASH"]

ip_address_ranges Sequence[str]: An array of IP address strings or CIDR ranges that this rule applies to.
name str: A unique identifier for the access rule.
squash_mode str: The squash mode for this specific rule. Currently, only "NO_SQUASH" is supported for exceptions. Possible values: ["NO_SQUASH"]

ipAddressRanges List<String>: An array of IP address strings or CIDR ranges that this rule applies to.
name String: A unique identifier for the access rule.
squashMode String: The squash mode for this specific rule. Currently, only "NO_SQUASH" is supported for exceptions. Possible values: ["NO_SQUASH"]