Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. filestore
  5. getInstance
Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.filestore.getInstance

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi
pulumi/pulumi-gcp

    Get info about a Google Cloud Filestore instance.

    Example Usage

    data "google_filestore_instance" "my_instance" {
  name = "my-filestore-instance"
}

output "instance_ip_addresses" {
  value = data.google_filestore_instance.my_instance.networks.ip_addresses
}

output "instance_connect_mode" {
  value = data.google_filestore_instance.my_instance.networks.connect_mode
}

output "instance_file_share_name" {
  value = data.google_filestore_instance.my_instance.file_shares.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.

    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)
// Output-based functions aren't available in Java yet

    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
    Description string
    EffectiveLabels Dictionary<string, string>
    Etag string
    FileShares List<GetInstanceFileShare>
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyName string
    Labels Dictionary<string, string>
    Name string
    Networks List<GetInstanceNetwork>
    PulumiLabels Dictionary<string, string>
    Tier string
    Zone string
    Location string
    Project string
    CreateTime string
    Description string
    EffectiveLabels map[string]string
    Etag string
    FileShares []GetInstanceFileShare
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyName string
    Labels map[string]string
    Name string
    Networks []GetInstanceNetwork
    PulumiLabels map[string]string
    Tier string
    Zone string
    Location string
    Project string
    createTime String
    description String
    effectiveLabels Map<String,String>
    etag String
    fileShares List<GetInstanceFileShare>
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyName String
    labels Map<String,String>
    name String
    networks List<GetInstanceNetwork>
    pulumiLabels Map<String,String>
    tier String
    zone String
    location String
    project String
    createTime string
    description string
    effectiveLabels {[key: string]: string}
    etag string
    fileShares GetInstanceFileShare[]
    id string
    The provider-assigned unique ID for this managed resource.
    kmsKeyName string
    labels {[key: string]: string}
    name string
    networks GetInstanceNetwork[]
    pulumiLabels {[key: string]: string}
    tier string
    zone string
    location string
    project string
    create_time str
    description str
    effective_labels Mapping[str, str]
    etag str
    file_shares Sequence[GetInstanceFileShare]
    id str
    The provider-assigned unique ID for this managed resource.
    kms_key_name str
    labels Mapping[str, str]
    name str
    networks Sequence[GetInstanceNetwork]
    pulumi_labels Mapping[str, str]
    tier str
    zone str
    location str
    project str
    createTime String
    description String
    effectiveLabels Map<String>
    etag String
    fileShares List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyName String
    labels Map<String>
    name String
    networks List<Property Map>
    pulumiLabels Map<String>
    tier String
    zone String
    location String
    project String

    Supporting Types

    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"]

    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.

    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.
    gcp logo
    Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi
    pulumi/pulumi-gcp