Google Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Thursday, May 19, 2022 by Pulumi

getInstance

Gets the details of a specific instance.

Using getInstance

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

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

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

public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:file/v1:getInstance
  Arguments:
    # Arguments dictionary

The following arguments are supported:

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

getInstance Result

The following output properties are available:

CreateTime string

The time when the instance was created.

Description string

The description of the instance (2048 characters or less).

Etag string

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

FileShares List<Pulumi.GoogleNative.File.V1.Outputs.FileShareConfigResponse>

File system shares on the instance. For this version, only a single file share is supported.

KmsKeyName string

KMS key name used for data encryption.

Labels Dictionary<string, string>

Resource labels to represent user provided metadata.

Name string

The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

Networks List<Pulumi.GoogleNative.File.V1.Outputs.NetworkConfigResponse>

VPC networks to which the instance is connected. For this version, only a single network is supported.

SatisfiesPzs bool

Reserved for future use.

State string

The instance state.

StatusMessage string

Additional information about the instance state, if available.

SuspensionReasons List<string>

Field indicates all the reasons the instance is in "SUSPENDED" state.

Tier string

The service tier of the instance.

CreateTime string

The time when the instance was created.

Description string

The description of the instance (2048 characters or less).

Etag string

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

FileShares []FileShareConfigResponse

File system shares on the instance. For this version, only a single file share is supported.

KmsKeyName string

KMS key name used for data encryption.

Labels map[string]string

Resource labels to represent user provided metadata.

Name string

The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

Networks []NetworkConfigResponse

VPC networks to which the instance is connected. For this version, only a single network is supported.

SatisfiesPzs bool

Reserved for future use.

State string

The instance state.

StatusMessage string

Additional information about the instance state, if available.

SuspensionReasons []string

Field indicates all the reasons the instance is in "SUSPENDED" state.

Tier string

The service tier of the instance.

createTime String

The time when the instance was created.

description String

The description of the instance (2048 characters or less).

etag String

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

fileShares ListShareConfigResponse>

File system shares on the instance. For this version, only a single file share is supported.

kmsKeyName String

KMS key name used for data encryption.

labels Map

Resource labels to represent user provided metadata.

name String

The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

networks ListConfigResponse>

VPC networks to which the instance is connected. For this version, only a single network is supported.

satisfiesPzs Boolean

Reserved for future use.

state String

The instance state.

statusMessage String

Additional information about the instance state, if available.

suspensionReasons List

Field indicates all the reasons the instance is in "SUSPENDED" state.

tier String

The service tier of the instance.

createTime string

The time when the instance was created.

description string

The description of the instance (2048 characters or less).

etag string

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

fileShares FileShareConfigResponse[]

File system shares on the instance. For this version, only a single file share is supported.

kmsKeyName string

KMS key name used for data encryption.

labels {[key: string]: string}

Resource labels to represent user provided metadata.

name string

The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

networks NetworkConfigResponse[]

VPC networks to which the instance is connected. For this version, only a single network is supported.

satisfiesPzs boolean

Reserved for future use.

state string

The instance state.

statusMessage string

Additional information about the instance state, if available.

suspensionReasons string[]

Field indicates all the reasons the instance is in "SUSPENDED" state.

tier string

The service tier of the instance.

create_time str

The time when the instance was created.

description str

The description of the instance (2048 characters or less).

etag str

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

file_shares Sequence[FileShareConfigResponse]

File system shares on the instance. For this version, only a single file share is supported.

kms_key_name str

KMS key name used for data encryption.

labels Mapping[str, str]

Resource labels to represent user provided metadata.

name str

The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

networks Sequence[NetworkConfigResponse]

VPC networks to which the instance is connected. For this version, only a single network is supported.

satisfies_pzs bool

Reserved for future use.

state str

The instance state.

status_message str

Additional information about the instance state, if available.

suspension_reasons Sequence[str]

Field indicates all the reasons the instance is in "SUSPENDED" state.

tier str

The service tier of the instance.

createTime String

The time when the instance was created.

description String

The description of the instance (2048 characters or less).

etag String

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

fileShares List

File system shares on the instance. For this version, only a single file share is supported.

kmsKeyName String

KMS key name used for data encryption.

labels Map

Resource labels to represent user provided metadata.

name String

The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

networks List

VPC networks to which the instance is connected. For this version, only a single network is supported.

satisfiesPzs Boolean

Reserved for future use.

state String

The instance state.

statusMessage String

Additional information about the instance state, if available.

suspensionReasons List

Field indicates all the reasons the instance is in "SUSPENDED" state.

tier String

The service tier of the instance.

Supporting Types

FileShareConfigResponse

CapacityGb string

File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.

Name string

The name of the file share (must be 16 characters or less).

NfsExportOptions List<Pulumi.GoogleNative.File.V1.Inputs.NfsExportOptionsResponse>

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/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

CapacityGb string

File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.

Name string

The name of the file share (must be 16 characters or less).

NfsExportOptions []NfsExportOptionsResponse

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/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

capacityGb String

File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.

name String

The name of the file share (must be 16 characters or less).

nfsExportOptions ListExportOptionsResponse>

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/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

capacityGb string

File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.

name string

The name of the file share (must be 16 characters or less).

nfsExportOptions NfsExportOptionsResponse[]

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/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

capacity_gb str

File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.

name str

The name of the file share (must be 16 characters or less).

nfs_export_options Sequence[NfsExportOptionsResponse]

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/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

capacityGb String

File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.

name String

The name of the file share (must be 16 characters or less).

nfsExportOptions List

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/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

NetworkConfigResponse

ConnectMode string

The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.

IpAddresses List<string>

IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.

Modes List<string>

Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.

Network string

The name of the Google Compute Engine VPC network to which the instance is connected.

ReservedIpRange string

Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier or a /24 CIDR block for High Scale or Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/24. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.

ConnectMode string

The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.

IpAddresses []string

IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.

Modes []string

Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.

Network string

The name of the Google Compute Engine VPC network to which the instance is connected.

ReservedIpRange string

Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier or a /24 CIDR block for High Scale or Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/24. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.

connectMode String

The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.

ipAddresses List

IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.

modes List

Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.

network String

The name of the Google Compute Engine VPC network to which the instance is connected.

reservedIpRange String

Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier or a /24 CIDR block for High Scale or Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/24. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.

connectMode string

The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.

ipAddresses string[]

IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.

modes string[]

Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.

network string

The name of the Google Compute Engine VPC network to which the instance is connected.

reservedIpRange string

Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier or a /24 CIDR block for High Scale or Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/24. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.

connect_mode str

The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.

ip_addresses Sequence[str]

IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.

modes Sequence[str]

Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.

network str

The name of the Google Compute Engine VPC network to which the instance is connected.

reserved_ip_range str

Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier or a /24 CIDR block for High Scale or Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/24. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.

connectMode String

The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.

ipAddresses List

IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.

modes List

Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.

network String

The name of the Google Compute Engine VPC network to which the instance is connected.

reservedIpRange String

Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier or a /24 CIDR block for High Scale or Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/24. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.

NfsExportOptionsResponse

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.

AnonGid string

An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

AnonUid string

An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

IpRanges List<string>

List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} 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.

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.

AnonGid string

An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

AnonUid string

An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

IpRanges []string

List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} 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.

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.

anonGid String

An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

anonUid String

An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

ipRanges List

List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} 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.

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.

anonGid string

An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

anonUid string

An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

ipRanges string[]

List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} 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.

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.

anon_gid str

An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

anon_uid str

An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

ip_ranges Sequence[str]

List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} 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.

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.

anonGid String

An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

anonUid String

An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

ipRanges List

List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} 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.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0