1. Packages
  2. Vantage Provider
  3. API Docs
  4. Folder
vantage 0.1.50 published on Monday, Apr 7, 2025 by vantage-sh

vantage.Folder

Explore with Pulumi AI

Manages a Folder.

Example Usage

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

const demoFolder = new vantage.Folder("demoFolder", {
    title: "Demo Folder",
    workspaceToken: "wrkspc_47c3254c790e9351",
});
Copy
import pulumi
import pulumi_vantage as vantage

demo_folder = vantage.Folder("demoFolder",
    title="Demo Folder",
    workspace_token="wrkspc_47c3254c790e9351")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vantage.NewFolder(ctx, "demoFolder", &vantage.FolderArgs{
			Title:          pulumi.String("Demo Folder"),
			WorkspaceToken: pulumi.String("wrkspc_47c3254c790e9351"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vantage = Pulumi.Vantage;

return await Deployment.RunAsync(() => 
{
    var demoFolder = new Vantage.Folder("demoFolder", new()
    {
        Title = "Demo Folder",
        WorkspaceToken = "wrkspc_47c3254c790e9351",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vantage.Folder;
import com.pulumi.vantage.FolderArgs;
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) {
        var demoFolder = new Folder("demoFolder", FolderArgs.builder()
            .title("Demo Folder")
            .workspaceToken("wrkspc_47c3254c790e9351")
            .build());

    }
}
Copy
resources:
  demoFolder:
    type: vantage:Folder
    properties:
      title: Demo Folder
      # Uncomment one of the following:
      #     // parent_folder_token = "fldr_47c3254c790e9351"
      workspaceToken: wrkspc_47c3254c790e9351
Copy

Create Folder Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Folder(name: string, args: FolderArgs, opts?: CustomResourceOptions);
@overload
def Folder(resource_name: str,
           args: FolderArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Folder(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           title: Optional[str] = None,
           parent_folder_token: Optional[str] = None,
           workspace_token: Optional[str] = None)
func NewFolder(ctx *Context, name string, args FolderArgs, opts ...ResourceOption) (*Folder, error)
public Folder(string name, FolderArgs args, CustomResourceOptions? opts = null)
public Folder(String name, FolderArgs args)
public Folder(String name, FolderArgs args, CustomResourceOptions options)
type: vantage:Folder
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FolderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FolderArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FolderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FolderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FolderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var folderResource = new Vantage.Folder("folderResource", new()
{
    Title = "string",
    ParentFolderToken = "string",
    WorkspaceToken = "string",
});
Copy
example, err := vantage.NewFolder(ctx, "folderResource", &vantage.FolderArgs{
Title: pulumi.String("string"),
ParentFolderToken: pulumi.String("string"),
WorkspaceToken: pulumi.String("string"),
})
Copy
var folderResource = new Folder("folderResource", FolderArgs.builder()
    .title("string")
    .parentFolderToken("string")
    .workspaceToken("string")
    .build());
Copy
folder_resource = vantage.Folder("folderResource",
    title="string",
    parent_folder_token="string",
    workspace_token="string")
Copy
const folderResource = new vantage.Folder("folderResource", {
    title: "string",
    parentFolderToken: "string",
    workspaceToken: "string",
});
Copy
type: vantage:Folder
properties:
    parentFolderToken: string
    title: string
    workspaceToken: string
Copy

Folder Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Folder resource accepts the following input properties:

Title This property is required. string
Title of the folder
ParentFolderToken string
Token of the folder's parent folder
WorkspaceToken string
Workspace token to add the cost report to.
Title This property is required. string
Title of the folder
ParentFolderToken string
Token of the folder's parent folder
WorkspaceToken string
Workspace token to add the cost report to.
title This property is required. String
Title of the folder
parentFolderToken String
Token of the folder's parent folder
workspaceToken String
Workspace token to add the cost report to.
title This property is required. string
Title of the folder
parentFolderToken string
Token of the folder's parent folder
workspaceToken string
Workspace token to add the cost report to.
title This property is required. str
Title of the folder
parent_folder_token str
Token of the folder's parent folder
workspace_token str
Workspace token to add the cost report to.
title This property is required. String
Title of the folder
parentFolderToken String
Token of the folder's parent folder
workspaceToken String
Workspace token to add the cost report to.

Outputs

All input properties are implicitly available as output properties. Additionally, the Folder resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Token string
Unique folder identifier
Id string
The provider-assigned unique ID for this managed resource.
Token string
Unique folder identifier
id String
The provider-assigned unique ID for this managed resource.
token String
Unique folder identifier
id string
The provider-assigned unique ID for this managed resource.
token string
Unique folder identifier
id str
The provider-assigned unique ID for this managed resource.
token str
Unique folder identifier
id String
The provider-assigned unique ID for this managed resource.
token String
Unique folder identifier

Look up Existing Folder Resource

Get an existing Folder resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FolderState, opts?: CustomResourceOptions): Folder
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        parent_folder_token: Optional[str] = None,
        title: Optional[str] = None,
        token: Optional[str] = None,
        workspace_token: Optional[str] = None) -> Folder
func GetFolder(ctx *Context, name string, id IDInput, state *FolderState, opts ...ResourceOption) (*Folder, error)
public static Folder Get(string name, Input<string> id, FolderState? state, CustomResourceOptions? opts = null)
public static Folder get(String name, Output<String> id, FolderState state, CustomResourceOptions options)
resources:  _:    type: vantage:Folder    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ParentFolderToken string
Token of the folder's parent folder
Title string
Title of the folder
Token string
Unique folder identifier
WorkspaceToken string
Workspace token to add the cost report to.
ParentFolderToken string
Token of the folder's parent folder
Title string
Title of the folder
Token string
Unique folder identifier
WorkspaceToken string
Workspace token to add the cost report to.
parentFolderToken String
Token of the folder's parent folder
title String
Title of the folder
token String
Unique folder identifier
workspaceToken String
Workspace token to add the cost report to.
parentFolderToken string
Token of the folder's parent folder
title string
Title of the folder
token string
Unique folder identifier
workspaceToken string
Workspace token to add the cost report to.
parent_folder_token str
Token of the folder's parent folder
title str
Title of the folder
token str
Unique folder identifier
workspace_token str
Workspace token to add the cost report to.
parentFolderToken String
Token of the folder's parent folder
title String
Title of the folder
token String
Unique folder identifier
workspaceToken String
Workspace token to add the cost report to.

Package Details

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