1. Packages
  2. Splight
  3. API Docs
  4. FileFolder
splight v1.1.9 published on Friday, Oct 18, 2024 by splightplatform

splight.FileFolder

Explore with Pulumi AI

splight logo
splight v1.1.9 published on Friday, Oct 18, 2024 by splightplatform

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as splight from "@splightplatform/pulumi-splight";
    
    const myFileParentFolder = new splight.FileFolder("myFileParentFolder", {});
    const myFileFolder = new splight.FileFolder("myFileFolder", {parent: myFileParentFolder.id});
    
    import pulumi
    import pulumi_splight as splight
    
    my_file_parent_folder = splight.FileFolder("myFileParentFolder")
    my_file_folder = splight.FileFolder("myFileFolder", parent=my_file_parent_folder.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/splightplatform/pulumi-splight/sdk/go/splight"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		myFileParentFolder, err := splight.NewFileFolder(ctx, "myFileParentFolder", nil)
    		if err != nil {
    			return err
    		}
    		_, err = splight.NewFileFolder(ctx, "myFileFolder", &splight.FileFolderArgs{
    			Parent: myFileParentFolder.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Splight = Splight.Splight;
    
    return await Deployment.RunAsync(() => 
    {
        var myFileParentFolder = new Splight.FileFolder("myFileParentFolder");
    
        var myFileFolder = new Splight.FileFolder("myFileFolder", new()
        {
            Parent = myFileParentFolder.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.splight.FileFolder;
    import com.pulumi.splight.FileFolderArgs;
    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 myFileParentFolder = new FileFolder("myFileParentFolder");
    
            var myFileFolder = new FileFolder("myFileFolder", FileFolderArgs.builder()
                .parent(myFileParentFolder.id())
                .build());
    
        }
    }
    
    resources:
      myFileParentFolder:
        type: splight:FileFolder
      myFileFolder:
        type: splight:FileFolder
        properties:
          parent: ${myFileParentFolder.id}
    

    Create FileFolder Resource

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

    Constructor syntax

    new FileFolder(name: string, args?: FileFolderArgs, opts?: CustomResourceOptions);
    @overload
    def FileFolder(resource_name: str,
                   args: Optional[FileFolderArgs] = None,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def FileFolder(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   name: Optional[str] = None,
                   parent: Optional[str] = None)
    func NewFileFolder(ctx *Context, name string, args *FileFolderArgs, opts ...ResourceOption) (*FileFolder, error)
    public FileFolder(string name, FileFolderArgs? args = null, CustomResourceOptions? opts = null)
    public FileFolder(String name, FileFolderArgs args)
    public FileFolder(String name, FileFolderArgs args, CustomResourceOptions options)
    
    type: splight:FileFolder
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FileFolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FileFolderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FileFolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileFolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileFolderArgs
    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 fileFolderResource = new Splight.FileFolder("fileFolderResource", new()
    {
        Name = "string",
        Parent = "string",
    });
    
    example, err := splight.NewFileFolder(ctx, "fileFolderResource", &splight.FileFolderArgs{
    	Name:   pulumi.String("string"),
    	Parent: pulumi.String("string"),
    })
    
    var fileFolderResource = new FileFolder("fileFolderResource", FileFolderArgs.builder()
        .name("string")
        .parent("string")
        .build());
    
    file_folder_resource = splight.FileFolder("fileFolderResource",
        name="string",
        parent="string")
    
    const fileFolderResource = new splight.FileFolder("fileFolderResource", {
        name: "string",
        parent: "string",
    });
    
    type: splight:FileFolder
    properties:
        name: string
        parent: string
    

    FileFolder Resource Properties

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

    Inputs

    The FileFolder resource accepts the following input properties:

    Name string
    folder name
    Parent string
    optional folder id where to place this folder
    Name string
    folder name
    Parent string
    optional folder id where to place this folder
    name String
    folder name
    parent String
    optional folder id where to place this folder
    name string
    folder name
    parent string
    optional folder id where to place this folder
    name str
    folder name
    parent str
    optional folder id where to place this folder
    name String
    folder name
    parent String
    optional folder id where to place this folder

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FileFolder Resource

    Get an existing FileFolder 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?: FileFolderState, opts?: CustomResourceOptions): FileFolder
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            parent: Optional[str] = None) -> FileFolder
    func GetFileFolder(ctx *Context, name string, id IDInput, state *FileFolderState, opts ...ResourceOption) (*FileFolder, error)
    public static FileFolder Get(string name, Input<string> id, FileFolderState? state, CustomResourceOptions? opts = null)
    public static FileFolder get(String name, Output<String> id, FileFolderState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Name string
    folder name
    Parent string
    optional folder id where to place this folder
    Name string
    folder name
    Parent string
    optional folder id where to place this folder
    name String
    folder name
    parent String
    optional folder id where to place this folder
    name string
    folder name
    parent string
    optional folder id where to place this folder
    name str
    folder name
    parent str
    optional folder id where to place this folder
    name String
    folder name
    parent String
    optional folder id where to place this folder

    Import

    $ pulumi import splight:index/fileFolder:FileFolder [options] splight_file_folder.<name> <file_folder_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    splight splightplatform/pulumi-splight
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the splight Terraform Provider.
    splight logo
    splight v1.1.9 published on Friday, Oct 18, 2024 by splightplatform