google-native.file/v1beta1.getShare

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

Using getShare

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 getShare(args: GetShareArgs, opts?: InvokeOptions): Promise<GetShareResult>
function getShareOutput(args: GetShareOutputArgs, opts?: InvokeOptions): Output<GetShareResult>

def get_share(instance_id: Optional[str] = None,
              location: Optional[str] = None,
              project: Optional[str] = None,
              share_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetShareResult
def get_share_output(instance_id: Optional[pulumi.Input[str]] = None,
              location: Optional[pulumi.Input[str]] = None,
              project: Optional[pulumi.Input[str]] = None,
              share_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetShareResult]

func LookupShare(ctx *Context, args *LookupShareArgs, opts ...InvokeOption) (*LookupShareResult, error)
func LookupShareOutput(ctx *Context, args *LookupShareOutputArgs, opts ...InvokeOption) LookupShareResultOutput

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

public static class GetShare 
{
    public static Task<GetShareResult> InvokeAsync(GetShareArgs args, InvokeOptions? opts = null)
    public static Output<GetShareResult> Invoke(GetShareInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetShareResult> getShare(GetShareArgs args, InvokeOptions options)
public static Output<GetShareResult> getShare(GetShareArgs args, InvokeOptions options)

fn::invoke:
  function: google-native:file/v1beta1:getShare
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string
Location string
ShareId string
Project string

InstanceId string
Location string
ShareId string
Project string

instanceId String
location String
shareId String
project String

instanceId string
location string
shareId string
project string

instance_id str
location str
share_id str
project str

instanceId String
location String
shareId String
project String

getShare Result

The following output properties are available:

Backup string: Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if the Share is created from scratch and not restored from a backup.
CapacityGb string: File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0.
CreateTime string: The time when the share was created.
Description string: A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.
Labels Dictionary<string, string>: Resource labels to represent user provided metadata.
MountName string: The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
Name string: The resource name of the share, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}.
NfsExportOptions List<Pulumi.GoogleNative.File.V1Beta1.Outputs.NfsExportOptionsResponse>: Nfs Export Options. There is a limit of 10 export options per file share.
State string: The share state.

Backup string: Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if the Share is created from scratch and not restored from a backup.
CapacityGb string: File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0.
CreateTime string: The time when the share was created.
Description string: A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.
Labels map[string]string: Resource labels to represent user provided metadata.
MountName string: The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
Name string: The resource name of the share, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}.
NfsExportOptions []NfsExportOptionsResponse: Nfs Export Options. There is a limit of 10 export options per file share.
State string: The share state.

backup String: Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if the Share is created from scratch and not restored from a backup.
capacityGb String: File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0.
createTime String: The time when the share was created.
description String: A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.
labels Map<String,String>: Resource labels to represent user provided metadata.
mountName String: The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
name String: The resource name of the share, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}.
nfsExportOptions List<NfsExportOptionsResponse>: Nfs Export Options. There is a limit of 10 export options per file share.
state String: The share state.

backup string: Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if the Share is created from scratch and not restored from a backup.
capacityGb string: File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0.
createTime string: The time when the share was created.
description string: A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.
labels {[key: string]: string}: Resource labels to represent user provided metadata.
mountName string: The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
name string: The resource name of the share, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}.
nfsExportOptions NfsExportOptionsResponse[]: Nfs Export Options. There is a limit of 10 export options per file share.
state string: The share state.

backup str: Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if the Share is created from scratch and not restored from a backup.
capacity_gb str: File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0.
create_time str: The time when the share was created.
description str: A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.
labels Mapping[str, str]: Resource labels to represent user provided metadata.
mount_name str: The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
name str: The resource name of the share, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}.
nfs_export_options Sequence[NfsExportOptionsResponse]: Nfs Export Options. There is a limit of 10 export options per file share.
state str: The share state.

backup String: Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if the Share is created from scratch and not restored from a backup.
capacityGb String: File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0.
createTime String: The time when the share was created.
description String: A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.
labels Map<String>: Resource labels to represent user provided metadata.
mountName String: The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
name String: The resource name of the share, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}.
nfsExportOptions List<Property Map>: Nfs Export Options. There is a limit of 10 export options per file share.
state String: The share state.

Supporting Types

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.
SecurityFlavors List<string>: The security flavors allowed for mount operations. The default is AUTH_SYS.
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.
SecurityFlavors []string: The security flavors allowed for mount operations. The default is AUTH_SYS.
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<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.
securityFlavors List<String>: The security flavors allowed for mount operations. The default is AUTH_SYS.
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.
securityFlavors string[]: The security flavors allowed for mount operations. The default is AUTH_SYS.
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.
security_flavors Sequence[str]: The security flavors allowed for mount operations. The default is AUTH_SYS.
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<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.
securityFlavors List<String>: The security flavors allowed for mount operations. The default is AUTH_SYS.
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.