vkcs.getSharedfilesystemShare

Explore with Pulumi AI

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

Example Usage

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

const data = vkcs.getSharedfilesystemShare({
    name: "share-data-tf-example",
    shareNetworkId: vkcs_sharedfilesystem_sharenetwork.data.id,
});

import pulumi
import pulumi_vkcs as vkcs

data = vkcs.get_sharedfilesystem_share(name="share-data-tf-example",
    share_network_id=vkcs_sharedfilesystem_sharenetwork["data"]["id"])

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.LookupSharedfilesystemShare(ctx, &vkcs.LookupSharedfilesystemShareArgs{
			Name:           pulumi.StringRef("share-data-tf-example"),
			ShareNetworkId: vkcs_sharedfilesystem_sharenetwork.Data.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var data = Vkcs.GetSharedfilesystemShare.Invoke(new()
    {
        Name = "share-data-tf-example",
        ShareNetworkId = vkcs_sharedfilesystem_sharenetwork.Data.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.VkcsFunctions;
import com.pulumi.vkcs.inputs.GetSharedfilesystemShareArgs;
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 data = VkcsFunctions.getSharedfilesystemShare(GetSharedfilesystemShareArgs.builder()
            .name("share-data-tf-example")
            .shareNetworkId(vkcs_sharedfilesystem_sharenetwork.data().id())
            .build());

    }
}

variables:
  data:
    fn::invoke:
      function: vkcs:getSharedfilesystemShare
      arguments:
        name: share-data-tf-example
        shareNetworkId: ${vkcs_sharedfilesystem_sharenetwork.data.id}

Using getSharedfilesystemShare

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 getSharedfilesystemShare(args: GetSharedfilesystemShareArgs, opts?: InvokeOptions): Promise<GetSharedfilesystemShareResult>
function getSharedfilesystemShareOutput(args: GetSharedfilesystemShareOutputArgs, opts?: InvokeOptions): Output<GetSharedfilesystemShareResult>

def get_sharedfilesystem_share(description: Optional[str] = None,
                               export_location_path: Optional[str] = None,
                               name: Optional[str] = None,
                               region: Optional[str] = None,
                               share_network_id: Optional[str] = None,
                               snapshot_id: Optional[str] = None,
                               status: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetSharedfilesystemShareResult
def get_sharedfilesystem_share_output(description: Optional[pulumi.Input[str]] = None,
                               export_location_path: Optional[pulumi.Input[str]] = None,
                               name: Optional[pulumi.Input[str]] = None,
                               region: Optional[pulumi.Input[str]] = None,
                               share_network_id: Optional[pulumi.Input[str]] = None,
                               snapshot_id: Optional[pulumi.Input[str]] = None,
                               status: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetSharedfilesystemShareResult]

func LookupSharedfilesystemShare(ctx *Context, args *LookupSharedfilesystemShareArgs, opts ...InvokeOption) (*LookupSharedfilesystemShareResult, error)
func LookupSharedfilesystemShareOutput(ctx *Context, args *LookupSharedfilesystemShareOutputArgs, opts ...InvokeOption) LookupSharedfilesystemShareResultOutput

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

public static class GetSharedfilesystemShare 
{
    public static Task<GetSharedfilesystemShareResult> InvokeAsync(GetSharedfilesystemShareArgs args, InvokeOptions? opts = null)
    public static Output<GetSharedfilesystemShareResult> Invoke(GetSharedfilesystemShareInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSharedfilesystemShareResult> getSharedfilesystemShare(GetSharedfilesystemShareArgs args, InvokeOptions options)
public static Output<GetSharedfilesystemShareResult> getSharedfilesystemShare(GetSharedfilesystemShareArgs args, InvokeOptions options)

fn::invoke:
  function: vkcs:index/getSharedfilesystemShare:getSharedfilesystemShare
  arguments:
    # arguments dictionary

The following arguments are supported:

ShareNetworkId string: required string → The UUID of the share's share network.
Description string: optional string → The human-readable description for the share.
ExportLocationPath string: optional string → The export location path of the share.
Name string: optional string → The name of the share.
Region string: optional string → The region in which to obtain the Shared File System client.
SnapshotId string: optional string → The UUID of the share's base snapshot.
Status string: optional string → A share status filter. A valid value is creating, error, available, deleting, error_deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, unmanaged, extending, extending_error, shrinking, shrinking_error, or shrinking_possible_data_loss_error.

ShareNetworkId string: required string → The UUID of the share's share network.
Description string: optional string → The human-readable description for the share.
ExportLocationPath string: optional string → The export location path of the share.
Name string: optional string → The name of the share.
Region string: optional string → The region in which to obtain the Shared File System client.
SnapshotId string: optional string → The UUID of the share's base snapshot.
Status string: optional string → A share status filter. A valid value is creating, error, available, deleting, error_deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, unmanaged, extending, extending_error, shrinking, shrinking_error, or shrinking_possible_data_loss_error.

shareNetworkId String: required string → The UUID of the share's share network.
description String: optional string → The human-readable description for the share.
exportLocationPath String: optional string → The export location path of the share.
name String: optional string → The name of the share.
region String: optional string → The region in which to obtain the Shared File System client.
snapshotId String: optional string → The UUID of the share's base snapshot.
status String: optional string → A share status filter. A valid value is creating, error, available, deleting, error_deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, unmanaged, extending, extending_error, shrinking, shrinking_error, or shrinking_possible_data_loss_error.

shareNetworkId string: required string → The UUID of the share's share network.
description string: optional string → The human-readable description for the share.
exportLocationPath string: optional string → The export location path of the share.
name string: optional string → The name of the share.
region string: optional string → The region in which to obtain the Shared File System client.
snapshotId string: optional string → The UUID of the share's base snapshot.
status string: optional string → A share status filter. A valid value is creating, error, available, deleting, error_deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, unmanaged, extending, extending_error, shrinking, shrinking_error, or shrinking_possible_data_loss_error.

share_network_id str: required string → The UUID of the share's share network.
description str: optional string → The human-readable description for the share.
export_location_path str: optional string → The export location path of the share.
name str: optional string → The name of the share.
region str: optional string → The region in which to obtain the Shared File System client.
snapshot_id str: optional string → The UUID of the share's base snapshot.
status str: optional string → A share status filter. A valid value is creating, error, available, deleting, error_deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, unmanaged, extending, extending_error, shrinking, shrinking_error, or shrinking_possible_data_loss_error.

shareNetworkId String: required string → The UUID of the share's share network.
description String: optional string → The human-readable description for the share.
exportLocationPath String: optional string → The export location path of the share.
name String: optional string → The name of the share.
region String: optional string → The region in which to obtain the Shared File System client.
snapshotId String: optional string → The UUID of the share's base snapshot.
status String: optional string → A share status filter. A valid value is creating, error, available, deleting, error_deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, unmanaged, extending, extending_error, shrinking, shrinking_error, or shrinking_possible_data_loss_error.

getSharedfilesystemShare Result

The following output properties are available:

AvailabilityZone string: string → The share availability zone.
Description string
ExportLocationPath string
Id string: string → The UUID of the share.
Name string
ProjectId string: string → The owner of the share.
Region string
ShareNetworkId string
ShareProto string: string → The share protocol.
Size double: number → The share size, in GBs.
SnapshotId string
Status string

AvailabilityZone string: string → The share availability zone.
Description string
ExportLocationPath string
Id string: string → The UUID of the share.
Name string
ProjectId string: string → The owner of the share.
Region string
ShareNetworkId string
ShareProto string: string → The share protocol.
Size float64: number → The share size, in GBs.
SnapshotId string
Status string

availabilityZone String: string → The share availability zone.
description String
exportLocationPath String
id String: string → The UUID of the share.
name String
projectId String: string → The owner of the share.
region String
shareNetworkId String
shareProto String: string → The share protocol.
size Double: number → The share size, in GBs.
snapshotId String
status String

availabilityZone string: string → The share availability zone.
description string
exportLocationPath string
id string: string → The UUID of the share.
name string
projectId string: string → The owner of the share.
region string
shareNetworkId string
shareProto string: string → The share protocol.
size number: number → The share size, in GBs.
snapshotId string
status string

availability_zone str: string → The share availability zone.
description str
export_location_path str
id str: string → The UUID of the share.
name str
project_id str: string → The owner of the share.
region str
share_network_id str
share_proto str: string → The share protocol.
size float: number → The share size, in GBs.
snapshot_id str
status str

availabilityZone String: string → The share availability zone.
description String
exportLocationPath String
id String: string → The UUID of the share.
name String
projectId String: string → The owner of the share.
region String
shareNetworkId String
shareProto String: string → The share protocol.
size Number: number → The share size, in GBs.
snapshotId String
status String

Package Details

Repository: vkcs vk-cs/terraform-provider-vkcs
License
Notes: This Pulumi package is based on the vkcs Terraform Provider.

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vk-cs/terraform-provider-vkcs

vkcs.getSharedfilesystemShare

On this page

On this page

Example Usage

Using getSharedfilesystemShare

getSharedfilesystemShare Result

Package Details

On this page

On this page