getFolder

vantage 0.3.15, Aug 5 26

Viewing docs for vantage 0.3.15
published on Wednesday, Aug 5, 2026 by vantage-sh

Using getFolder

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 getFolder(args: GetFolderArgs, opts?: InvokeOptions): Promise<GetFolderResult>
function getFolderOutput(args: GetFolderOutputArgs, opts?: InvokeOptions): Output<GetFolderResult>

def get_folder(parent_folder_token: Optional[str] = None,
               title: Optional[str] = None,
               workspace_token: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetFolderResult
def get_folder_output(parent_folder_token: pulumi.Input[Optional[str]] = None,
               title: pulumi.Input[Optional[str]] = None,
               workspace_token: pulumi.Input[Optional[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetFolderResult]

func LookupFolder(ctx *Context, args *LookupFolderArgs, opts ...InvokeOption) (*LookupFolderResult, error)
func LookupFolderOutput(ctx *Context, args *LookupFolderOutputArgs, opts ...InvokeOption) LookupFolderResultOutput

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

public static class GetFolder 
{
    public static Task<GetFolderResult> InvokeAsync(GetFolderArgs args, InvokeOptions? opts = null)
    public static Output<GetFolderResult> Invoke(GetFolderInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFolderResult> getFolder(GetFolderArgs args, InvokeOptions options)
public static Output<GetFolderResult> getFolder(GetFolderArgs args, InvokeOptions options)

fn::invoke:
  function: vantage:index/getFolder:getFolder
  arguments:
    # arguments dictionary

data "vantage_get_folder" "name" {
    # arguments
}

The following arguments are supported:

Title string: The title of the folder to find.
ParentFolderToken string: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
WorkspaceToken string: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

Title string: The title of the folder to find.
ParentFolderToken string: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
WorkspaceToken string: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

title string: The title of the folder to find.
parent_folder_token string: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
workspace_token string: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

title String: The title of the folder to find.
parentFolderToken String: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
workspaceToken String: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

title string: The title of the folder to find.
parentFolderToken string: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
workspaceToken string: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

title str: The title of the folder to find.
parent_folder_token str: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
workspace_token str: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

title String: The title of the folder to find.
parentFolderToken String: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
workspaceToken String: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

getFolder Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
ParentFolderToken string: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
Title string: The title of the folder to find.
Token string: The unique token of the matched folder.
WorkspaceToken string: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

Id string: The provider-assigned unique ID for this managed resource.
ParentFolderToken string: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
Title string: The title of the folder to find.
Token string: The unique token of the matched folder.
WorkspaceToken string: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

id string: The provider-assigned unique ID for this managed resource.
parent_folder_token string: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
title string: The title of the folder to find.
token string: The unique token of the matched folder.
workspace_token string: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

id String: The provider-assigned unique ID for this managed resource.
parentFolderToken String: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
title String: The title of the folder to find.
token String: The unique token of the matched folder.
workspaceToken String: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

id string: The provider-assigned unique ID for this managed resource.
parentFolderToken string: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
title string: The title of the folder to find.
token string: The unique token of the matched folder.
workspaceToken string: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

id str: The provider-assigned unique ID for this managed resource.
parent_folder_token str: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
title str: The title of the folder to find.
token str: The unique token of the matched folder.
workspace_token str: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

id String: The provider-assigned unique ID for this managed resource.
parentFolderToken String: Filter folders by parent folder token. Set to an empty string ("") to match only root-level folders (those with no parent). Also populated as an output with the parent folder token of the matched folder.
title String: The title of the folder to find.
token String: The unique token of the matched folder.
workspaceToken String: Filter folders by workspace token. If not specified, the first folder matching the title is returned. Also populated as an output with the workspace token of the matched folder.

Package Details

Repository: vantage vantage-sh/terraform-provider-vantage
License
Notes: This Pulumi package is based on the vantage Terraform Provider.

Viewing docs for vantage 0.3.15
published on Wednesday, Aug 5, 2026 by vantage-sh

Schema (JSON)

vantage-sh/terraform-provider-vantage

vantage.getFolder

On this page

On this page

Using getFolder

getFolder Result

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

vantage.getFolder

On this page

On this page

Using getFolder

getFolder Result

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.