Google Cloud v8.23.0, Mar 24 25

Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi

gcp.filestore.getInstance

Explore with Pulumi AI

Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const myInstance = gcp.filestore.getInstance({
    name: "my-filestore-instance",
});
export const instanceIpAddresses = myInstance.then(myInstance => myInstance.networks?.ipAddresses);
export const instanceConnectMode = myInstance.then(myInstance => myInstance.networks?.connectMode);
export const instanceFileShareName = myInstance.then(myInstance => myInstance.fileShares?.name);

import pulumi
import pulumi_gcp as gcp

my_instance = gcp.filestore.get_instance(name="my-filestore-instance")
pulumi.export("instanceIpAddresses", my_instance.networks.ip_addresses)
pulumi.export("instanceConnectMode", my_instance.networks.connect_mode)
pulumi.export("instanceFileShareName", my_instance.file_shares.name)

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/filestore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myInstance, err := filestore.LookupInstance(ctx, &filestore.LookupInstanceArgs{
			Name: "my-filestore-instance",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("instanceIpAddresses", myInstance.Networks.IpAddresses)
		ctx.Export("instanceConnectMode", myInstance.Networks.ConnectMode)
		ctx.Export("instanceFileShareName", myInstance.FileShares.Name)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var myInstance = Gcp.Filestore.GetInstance.Invoke(new()
    {
        Name = "my-filestore-instance",
    });

    return new Dictionary<string, object?>
    {
        ["instanceIpAddresses"] = myInstance.Apply(getInstanceResult => getInstanceResult.Networks?.IpAddresses),
        ["instanceConnectMode"] = myInstance.Apply(getInstanceResult => getInstanceResult.Networks?.ConnectMode),
        ["instanceFileShareName"] = myInstance.Apply(getInstanceResult => getInstanceResult.FileShares?.Name),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.filestore.FilestoreFunctions;
import com.pulumi.gcp.filestore.inputs.GetInstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var myInstance = FilestoreFunctions.getInstance(GetInstanceArgs.builder()
            .name("my-filestore-instance")
            .build());

        ctx.export("instanceIpAddresses", myInstance.applyValue(getInstanceResult -> getInstanceResult.networks().ipAddresses()));
        ctx.export("instanceConnectMode", myInstance.applyValue(getInstanceResult -> getInstanceResult.networks().connectMode()));
        ctx.export("instanceFileShareName", myInstance.applyValue(getInstanceResult -> getInstanceResult.fileShares().name()));
    }
}

variables:
  myInstance:
    fn::invoke:
      function: gcp:filestore:getInstance
      arguments:
        name: my-filestore-instance
outputs:
  instanceIpAddresses: ${myInstance.networks.ipAddresses}
  instanceConnectMode: ${myInstance.networks.connectMode}
  instanceFileShareName: ${myInstance.fileShares.name}

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.

TypeScript
Python
Go
C#
Java
YAML

function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>

def get_instance(location: Optional[str] = None,
                 name: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(location: Optional[pulumi.Input[str]] = None,
                 name: 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)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

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

The following arguments are supported:

Name string: The name of a Filestore instance.
Location string: The name of the location of the instance. This can be a region for ENTERPRISE tier instances. If it is not provided, the provider region or zone is used.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.

Name string: The name of a Filestore instance.
Location string: The name of the location of the instance. This can be a region for ENTERPRISE tier instances. If it is not provided, the provider region or zone is used.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.

name String: The name of a Filestore instance.
location String: The name of the location of the instance. This can be a region for ENTERPRISE tier instances. If it is not provided, the provider region or zone is used.
project String: The project in which the resource belongs. If it is not provided, the provider project is used.

name string: The name of a Filestore instance.
location string: The name of the location of the instance. This can be a region for ENTERPRISE tier instances. If it is not provided, the provider region or zone is used.
project string: The project in which the resource belongs. If it is not provided, the provider project is used.

name str: The name of a Filestore instance.
location str: The name of the location of the instance. This can be a region for ENTERPRISE tier instances. If it is not provided, the provider region or zone is used.
project str: The project in which the resource belongs. If it is not provided, the provider project is used.

name String: The name of a Filestore instance.
location String: The name of the location of the instance. This can be a region for ENTERPRISE tier instances. If it is not provided, the provider region or zone is used.
project String: The project in which the resource belongs. If it is not provided, the provider project is used.

getInstance Result

The following output properties are available:

CreateTime string
DeletionProtectionEnabled bool
DeletionProtectionReason string
Description string
EffectiveLabels Dictionary<string, string>
EffectiveReplications List<GetInstanceEffectiveReplication>
Etag string
FileShares List<GetInstanceFileShare>
Id string: The provider-assigned unique ID for this managed resource.
InitialReplications List<GetInstanceInitialReplication>
KmsKeyName string
Labels Dictionary<string, string>
Name string
Networks List<GetInstanceNetwork>
PerformanceConfigs List<GetInstancePerformanceConfig>
Protocol string
PulumiLabels Dictionary<string, string>
Tags Dictionary<string, string>
Tier string
Zone string
Location string
Project string

CreateTime string
DeletionProtectionEnabled bool
DeletionProtectionReason string
Description string
EffectiveLabels map[string]string
EffectiveReplications []GetInstanceEffectiveReplication
Etag string
FileShares []GetInstanceFileShare
Id string: The provider-assigned unique ID for this managed resource.
InitialReplications []GetInstanceInitialReplication
KmsKeyName string
Labels map[string]string
Name string
Networks []GetInstanceNetwork
PerformanceConfigs []GetInstancePerformanceConfig
Protocol string
PulumiLabels map[string]string
Tags map[string]string
Tier string
Zone string
Location string
Project string

createTime String
deletionProtectionEnabled Boolean
deletionProtectionReason String
description String
effectiveLabels Map<String,String>
effectiveReplications List<GetInstanceEffectiveReplication>
etag String
fileShares List<GetInstanceFileShare>
id String: The provider-assigned unique ID for this managed resource.
initialReplications List<GetInstanceInitialReplication>
kmsKeyName String
labels Map<String,String>
name String
networks List<GetInstanceNetwork>
performanceConfigs List<GetInstancePerformanceConfig>
protocol String
pulumiLabels Map<String,String>
tags Map<String,String>
tier String
zone String
location String
project String

createTime string
deletionProtectionEnabled boolean
deletionProtectionReason string
description string
effectiveLabels {[key: string]: string}
effectiveReplications GetInstanceEffectiveReplication[]
etag string
fileShares GetInstanceFileShare[]
id string: The provider-assigned unique ID for this managed resource.
initialReplications GetInstanceInitialReplication[]
kmsKeyName string
labels {[key: string]: string}
name string
networks GetInstanceNetwork[]
performanceConfigs GetInstancePerformanceConfig[]
protocol string
pulumiLabels {[key: string]: string}
tags {[key: string]: string}
tier string
zone string
location string
project string

create_time str
deletion_protection_enabled bool
deletion_protection_reason str
description str
effective_labels Mapping[str, str]
effective_replications Sequence[GetInstanceEffectiveReplication]
etag str
file_shares Sequence[GetInstanceFileShare]
id str: The provider-assigned unique ID for this managed resource.
initial_replications Sequence[GetInstanceInitialReplication]
kms_key_name str
labels Mapping[str, str]
name str
networks Sequence[GetInstanceNetwork]
performance_configs Sequence[GetInstancePerformanceConfig]
protocol str
pulumi_labels Mapping[str, str]
tags Mapping[str, str]
tier str
zone str
location str
project str

createTime String
deletionProtectionEnabled Boolean
deletionProtectionReason String
description String
effectiveLabels Map<String>
effectiveReplications List<Property Map>
etag String
fileShares List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
initialReplications List<Property Map>
kmsKeyName String
labels Map<String>
name String
networks List<Property Map>
performanceConfigs List<Property Map>
protocol String
pulumiLabels Map<String>
tags Map<String>
tier String
zone String
location String
project String

Supporting Types

GetInstanceEffectiveReplication

Replicas List<GetInstanceEffectiveReplicationReplica>: The replication role.

Replicas []GetInstanceEffectiveReplicationReplica: The replication role.

replicas List<GetInstanceEffectiveReplicationReplica>: The replication role.

replicas GetInstanceEffectiveReplicationReplica[]: The replication role.

replicas Sequence[GetInstanceEffectiveReplicationReplica]: The replication role.

replicas List<Property Map>: The replication role.

GetInstanceEffectiveReplicationReplica

LastActiveSyncTime string: Output only. The timestamp of the latest replication snapshot taken on the active instance and is already replicated safely. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
State string: Output only. The replica state
StateReasons List<string>: Output only. Additional information about the replication state, if available.

LastActiveSyncTime string: Output only. The timestamp of the latest replication snapshot taken on the active instance and is already replicated safely. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
State string: Output only. The replica state
StateReasons []string: Output only. Additional information about the replication state, if available.

lastActiveSyncTime String: Output only. The timestamp of the latest replication snapshot taken on the active instance and is already replicated safely. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
state String: Output only. The replica state
stateReasons List<String>: Output only. Additional information about the replication state, if available.

lastActiveSyncTime string: Output only. The timestamp of the latest replication snapshot taken on the active instance and is already replicated safely. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
state string: Output only. The replica state
stateReasons string[]: Output only. Additional information about the replication state, if available.

last_active_sync_time str: Output only. The timestamp of the latest replication snapshot taken on the active instance and is already replicated safely. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
state str: Output only. The replica state
state_reasons Sequence[str]: Output only. Additional information about the replication state, if available.

lastActiveSyncTime String: Output only. The timestamp of the latest replication snapshot taken on the active instance and is already replicated safely. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
state String: Output only. The replica state
stateReasons List<String>: Output only. Additional information about the replication state, if available.

GetInstanceFileShare

CapacityGb int: File share capacity in GiB. This must be at least 1024 GiB for the standard tier, or 2560 GiB for the premium tier.
Name string: The name of a Filestore instance.
NfsExportOptions List<GetInstanceFileShareNfsExportOption>: Nfs Export Options. There is a limit of 10 export options per file share.
SourceBackup string: The resource name of the backup, in the format projects/{projectId}/locations/{locationId}/backups/{backupId}, that this file share has been restored from.

CapacityGb int: File share capacity in GiB. This must be at least 1024 GiB for the standard tier, or 2560 GiB for the premium tier.
Name string: The name of a Filestore instance.
NfsExportOptions []GetInstanceFileShareNfsExportOption: Nfs Export Options. There is a limit of 10 export options per file share.
SourceBackup string: The resource name of the backup, in the format projects/{projectId}/locations/{locationId}/backups/{backupId}, that this file share has been restored from.

capacityGb Integer: File share capacity in GiB. This must be at least 1024 GiB for the standard tier, or 2560 GiB for the premium tier.
name String: The name of a Filestore instance.
nfsExportOptions List<GetInstanceFileShareNfsExportOption>: Nfs Export Options. There is a limit of 10 export options per file share.
sourceBackup String: The resource name of the backup, in the format projects/{projectId}/locations/{locationId}/backups/{backupId}, that this file share has been restored from.

capacityGb number: File share capacity in GiB. This must be at least 1024 GiB for the standard tier, or 2560 GiB for the premium tier.
name string: The name of a Filestore instance.
nfsExportOptions GetInstanceFileShareNfsExportOption[]: Nfs Export Options. There is a limit of 10 export options per file share.
sourceBackup string: The resource name of the backup, in the format projects/{projectId}/locations/{locationId}/backups/{backupId}, that this file share has been restored from.

capacity_gb int: File share capacity in GiB. This must be at least 1024 GiB for the standard tier, or 2560 GiB for the premium tier.
name str: The name of a Filestore instance.
nfs_export_options Sequence[GetInstanceFileShareNfsExportOption]: Nfs Export Options. There is a limit of 10 export options per file share.
source_backup str: The resource name of the backup, in the format projects/{projectId}/locations/{locationId}/backups/{backupId}, that this file share has been restored from.

capacityGb Number: File share capacity in GiB. This must be at least 1024 GiB for the standard tier, or 2560 GiB for the premium tier.
name String: The name of a Filestore instance.
nfsExportOptions List<Property Map>: Nfs Export Options. There is a limit of 10 export options per file share.
sourceBackup String: The resource name of the backup, in the format projects/{projectId}/locations/{locationId}/backups/{backupId}, that this file share has been restored from.

GetInstanceFileShareNfsExportOption

AccessMode string: Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE. Default value: "READ_WRITE" Possible values: ["READ_ONLY", "READ_WRITE"]
AnonGid int: An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
AnonUid int: An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
IpRanges List<string>: List of either IPv4 addresses, or ranges in CIDR notation which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
SquashMode string: Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. Default value: "NO_ROOT_SQUASH" Possible values: ["NO_ROOT_SQUASH", "ROOT_SQUASH"]

AccessMode string: Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE. Default value: "READ_WRITE" Possible values: ["READ_ONLY", "READ_WRITE"]
AnonGid int: An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
AnonUid int: An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
IpRanges []string: List of either IPv4 addresses, or ranges in CIDR notation which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
SquashMode string: Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. Default value: "NO_ROOT_SQUASH" Possible values: ["NO_ROOT_SQUASH", "ROOT_SQUASH"]

accessMode String: Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE. Default value: "READ_WRITE" Possible values: ["READ_ONLY", "READ_WRITE"]
anonGid Integer: An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
anonUid Integer: An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
ipRanges List<String>: List of either IPv4 addresses, or ranges in CIDR notation which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
squashMode String: Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. Default value: "NO_ROOT_SQUASH" Possible values: ["NO_ROOT_SQUASH", "ROOT_SQUASH"]

accessMode string: Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE. Default value: "READ_WRITE" Possible values: ["READ_ONLY", "READ_WRITE"]
anonGid number: An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
anonUid number: An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
ipRanges string[]: List of either IPv4 addresses, or ranges in CIDR notation which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
squashMode string: Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. Default value: "NO_ROOT_SQUASH" Possible values: ["NO_ROOT_SQUASH", "ROOT_SQUASH"]

access_mode str: Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE. Default value: "READ_WRITE" Possible values: ["READ_ONLY", "READ_WRITE"]
anon_gid int: An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
anon_uid int: An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
ip_ranges Sequence[str]: List of either IPv4 addresses, or ranges in CIDR notation which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
squash_mode str: Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. Default value: "NO_ROOT_SQUASH" Possible values: ["NO_ROOT_SQUASH", "ROOT_SQUASH"]

accessMode String: Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE. Default value: "READ_WRITE" Possible values: ["READ_ONLY", "READ_WRITE"]
anonGid Number: An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
anonUid Number: An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
ipRanges List<String>: List of either IPv4 addresses, or ranges in CIDR notation which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
squashMode String: Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. Default value: "NO_ROOT_SQUASH" Possible values: ["NO_ROOT_SQUASH", "ROOT_SQUASH"]

GetInstanceInitialReplication

Replicas List<GetInstanceInitialReplicationReplica>: The replication role.
Role string: The replication role. Default value: "STANDBY" Possible values: ["ROLE_UNSPECIFIED", "ACTIVE", "STANDBY"]

Replicas []GetInstanceInitialReplicationReplica: The replication role.
Role string: The replication role. Default value: "STANDBY" Possible values: ["ROLE_UNSPECIFIED", "ACTIVE", "STANDBY"]

replicas List<GetInstanceInitialReplicationReplica>: The replication role.
role String: The replication role. Default value: "STANDBY" Possible values: ["ROLE_UNSPECIFIED", "ACTIVE", "STANDBY"]

replicas GetInstanceInitialReplicationReplica[]: The replication role.
role string: The replication role. Default value: "STANDBY" Possible values: ["ROLE_UNSPECIFIED", "ACTIVE", "STANDBY"]

replicas Sequence[GetInstanceInitialReplicationReplica]: The replication role.
role str: The replication role. Default value: "STANDBY" Possible values: ["ROLE_UNSPECIFIED", "ACTIVE", "STANDBY"]

replicas List<Property Map>: The replication role.
role String: The replication role. Default value: "STANDBY" Possible values: ["ROLE_UNSPECIFIED", "ACTIVE", "STANDBY"]

GetInstanceInitialReplicationReplica

PeerInstance string: The peer instance.

PeerInstance string: The peer instance.

peerInstance String: The peer instance.

peerInstance string: The peer instance.

peer_instance str: The peer instance.

peerInstance String: The peer instance.

GetInstanceNetwork

ConnectMode string: The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. Default value: "DIRECT_PEERING" Possible values: ["DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"]
IpAddresses List<string>: A list of IPv4 or IPv6 addresses.
Modes List<string>: IP versions for which the instance has IP addresses assigned. Possible values: ["ADDRESS_MODE_UNSPECIFIED", "MODE_IPV4", "MODE_IPV6"]
Network string: The name of the GCE VPC network to which the instance is connected.
ReservedIpRange string: A /29 CIDR block that identifies the range of IP addresses reserved for this instance.

ConnectMode string: The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. Default value: "DIRECT_PEERING" Possible values: ["DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"]
IpAddresses []string: A list of IPv4 or IPv6 addresses.
Modes []string: IP versions for which the instance has IP addresses assigned. Possible values: ["ADDRESS_MODE_UNSPECIFIED", "MODE_IPV4", "MODE_IPV6"]
Network string: The name of the GCE VPC network to which the instance is connected.
ReservedIpRange string: A /29 CIDR block that identifies the range of IP addresses reserved for this instance.

connectMode String: The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. Default value: "DIRECT_PEERING" Possible values: ["DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"]
ipAddresses List<String>: A list of IPv4 or IPv6 addresses.
modes List<String>: IP versions for which the instance has IP addresses assigned. Possible values: ["ADDRESS_MODE_UNSPECIFIED", "MODE_IPV4", "MODE_IPV6"]
network String: The name of the GCE VPC network to which the instance is connected.
reservedIpRange String: A /29 CIDR block that identifies the range of IP addresses reserved for this instance.

connectMode string: The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. Default value: "DIRECT_PEERING" Possible values: ["DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"]
ipAddresses string[]: A list of IPv4 or IPv6 addresses.
modes string[]: IP versions for which the instance has IP addresses assigned. Possible values: ["ADDRESS_MODE_UNSPECIFIED", "MODE_IPV4", "MODE_IPV6"]
network string: The name of the GCE VPC network to which the instance is connected.
reservedIpRange string: A /29 CIDR block that identifies the range of IP addresses reserved for this instance.

connect_mode str: The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. Default value: "DIRECT_PEERING" Possible values: ["DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"]
ip_addresses Sequence[str]: A list of IPv4 or IPv6 addresses.
modes Sequence[str]: IP versions for which the instance has IP addresses assigned. Possible values: ["ADDRESS_MODE_UNSPECIFIED", "MODE_IPV4", "MODE_IPV6"]
network str: The name of the GCE VPC network to which the instance is connected.
reserved_ip_range str: A /29 CIDR block that identifies the range of IP addresses reserved for this instance.

connectMode String: The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. Default value: "DIRECT_PEERING" Possible values: ["DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"]
ipAddresses List<String>: A list of IPv4 or IPv6 addresses.
modes List<String>: IP versions for which the instance has IP addresses assigned. Possible values: ["ADDRESS_MODE_UNSPECIFIED", "MODE_IPV4", "MODE_IPV6"]
network String: The name of the GCE VPC network to which the instance is connected.
reservedIpRange String: A /29 CIDR block that identifies the range of IP addresses reserved for this instance.

GetInstancePerformanceConfig

FixedIops List<GetInstancePerformanceConfigFixedIop>: The instance will have a fixed provisioned IOPS value, which will remain constant regardless of instance capacity.
IopsPerTbs List<GetInstancePerformanceConfigIopsPerTb>: The instance provisioned IOPS will change dynamically based on the capacity of the instance.

FixedIops []GetInstancePerformanceConfigFixedIop: The instance will have a fixed provisioned IOPS value, which will remain constant regardless of instance capacity.
IopsPerTbs []GetInstancePerformanceConfigIopsPerTb: The instance provisioned IOPS will change dynamically based on the capacity of the instance.

fixedIops List<GetInstancePerformanceConfigFixedIop>: The instance will have a fixed provisioned IOPS value, which will remain constant regardless of instance capacity.
iopsPerTbs List<GetInstancePerformanceConfigIopsPerTb>: The instance provisioned IOPS will change dynamically based on the capacity of the instance.

fixedIops GetInstancePerformanceConfigFixedIop[]: The instance will have a fixed provisioned IOPS value, which will remain constant regardless of instance capacity.
iopsPerTbs GetInstancePerformanceConfigIopsPerTb[]: The instance provisioned IOPS will change dynamically based on the capacity of the instance.

fixed_iops Sequence[GetInstancePerformanceConfigFixedIop]: The instance will have a fixed provisioned IOPS value, which will remain constant regardless of instance capacity.
iops_per_tbs Sequence[GetInstancePerformanceConfigIopsPerTb]: The instance provisioned IOPS will change dynamically based on the capacity of the instance.

fixedIops List<Property Map>: The instance will have a fixed provisioned IOPS value, which will remain constant regardless of instance capacity.
iopsPerTbs List<Property Map>: The instance provisioned IOPS will change dynamically based on the capacity of the instance.

GetInstancePerformanceConfigFixedIop

MaxIops int: The number of IOPS to provision for the instance. max_iops must be in multiple of 1000.

MaxIops int: The number of IOPS to provision for the instance. max_iops must be in multiple of 1000.

maxIops Integer: The number of IOPS to provision for the instance. max_iops must be in multiple of 1000.

maxIops number: The number of IOPS to provision for the instance. max_iops must be in multiple of 1000.

max_iops int: The number of IOPS to provision for the instance. max_iops must be in multiple of 1000.

maxIops Number: The number of IOPS to provision for the instance. max_iops must be in multiple of 1000.

GetInstancePerformanceConfigIopsPerTb

MaxIopsPerTb int: The instance max IOPS will be calculated by multiplying the capacity of the instance (TB) by max_iops_per_tb, and rounding to the nearest 1000. The instance max IOPS will be changed dynamically based on the instance capacity.

MaxIopsPerTb int: The instance max IOPS will be calculated by multiplying the capacity of the instance (TB) by max_iops_per_tb, and rounding to the nearest 1000. The instance max IOPS will be changed dynamically based on the instance capacity.

maxIopsPerTb Integer: The instance max IOPS will be calculated by multiplying the capacity of the instance (TB) by max_iops_per_tb, and rounding to the nearest 1000. The instance max IOPS will be changed dynamically based on the instance capacity.

maxIopsPerTb number: The instance max IOPS will be calculated by multiplying the capacity of the instance (TB) by max_iops_per_tb, and rounding to the nearest 1000. The instance max IOPS will be changed dynamically based on the instance capacity.

max_iops_per_tb int: The instance max IOPS will be calculated by multiplying the capacity of the instance (TB) by max_iops_per_tb, and rounding to the nearest 1000. The instance max IOPS will be changed dynamically based on the instance capacity.

maxIopsPerTb Number: The instance max IOPS will be calculated by multiplying the capacity of the instance (TB) by max_iops_per_tb, and rounding to the nearest 1000. The instance max IOPS will be changed dynamically based on the instance capacity.

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.filestore.getInstance

On this page

On this page

Example Usage

Using getInstance

getInstance Result

Supporting Types

GetInstanceEffectiveReplication

GetInstanceEffectiveReplicationReplica

GetInstanceFileShare

GetInstanceFileShareNfsExportOption

GetInstanceInitialReplication

GetInstanceInitialReplicationReplica

GetInstanceNetwork

GetInstancePerformanceConfig

GetInstancePerformanceConfigFixedIop

GetInstancePerformanceConfigIopsPerTb

Package Details

On this page

On this page