Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. FileStoreFolder
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-harness

harness.platform.FileStoreFolder

Explore with Pulumi AI

harness logo
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-harness

    Resource for creating folders in Harness.

    Example Usage

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

// Create folder
const example = new harness.platform.FileStoreFolder("example", {
    orgId: "org_id",
    projectId: "project_id",
    identifier: "identifier",
    name: "name",
    description: "description",
    tags: [
        "foo:bar",
        "baz:qux",
    ],
    parentIdentifier: "parent_identifier",
});

    import pulumi
import pulumi_harness as harness

# Create folder
example = harness.platform.FileStoreFolder("example",
    org_id="org_id",
    project_id="project_id",
    identifier="identifier",
    name="name",
    description="description",
    tags=[
        "foo:bar",
        "baz:qux",
    ],
    parent_identifier="parent_identifier")

    package main

import (
	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create folder
		_, err := platform.NewFileStoreFolder(ctx, "example", &platform.FileStoreFolderArgs{
			OrgId:       pulumi.String("org_id"),
			ProjectId:   pulumi.String("project_id"),
			Identifier:  pulumi.String("identifier"),
			Name:        pulumi.String("name"),
			Description: pulumi.String("description"),
			Tags: pulumi.StringArray{
				pulumi.String("foo:bar"),
				pulumi.String("baz:qux"),
			},
			ParentIdentifier: pulumi.String("parent_identifier"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Create folder
    var example = new Harness.Platform.FileStoreFolder("example", new()
    {
        OrgId = "org_id",
        ProjectId = "project_id",
        Identifier = "identifier",
        Name = "name",
        Description = "description",
        Tags = new[]
        {
            "foo:bar",
            "baz:qux",
        },
        ParentIdentifier = "parent_identifier",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.FileStoreFolder;
import com.pulumi.harness.platform.FileStoreFolderArgs;
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) {
        // Create folder
        var example = new FileStoreFolder("example", FileStoreFolderArgs.builder()
            .orgId("org_id")
            .projectId("project_id")
            .identifier("identifier")
            .name("name")
            .description("description")
            .tags(            
                "foo:bar",
                "baz:qux")
            .parentIdentifier("parent_identifier")
            .build());

    }
}

    resources:
  # Create folder
  example:
    type: harness:platform:FileStoreFolder
    properties:
      orgId: org_id
      projectId: project_id
      identifier: identifier
      name: name
      description: description
      tags:
        - foo:bar
        - baz:qux
      parentIdentifier: parent_identifier

    Create FileStoreFolder Resource

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

    Constructor syntax

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

@overload
def FileStoreFolder(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    identifier: Optional[str] = None,
                    parent_identifier: Optional[str] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    org_id: Optional[str] = None,
                    project_id: Optional[str] = None,
                    tags: Optional[Sequence[str]] = None)
    func NewFileStoreFolder(ctx *Context, name string, args FileStoreFolderArgs, opts ...ResourceOption) (*FileStoreFolder, error)
    public FileStoreFolder(string name, FileStoreFolderArgs args, CustomResourceOptions? opts = null)
    public FileStoreFolder(String name, FileStoreFolderArgs args)
public FileStoreFolder(String name, FileStoreFolderArgs args, CustomResourceOptions options)

    type: harness:platform:FileStoreFolder
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 FileStoreFolderArgs
    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 FileStoreFolderArgs
    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 FileStoreFolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileStoreFolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileStoreFolderArgs
    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 fileStoreFolderResource = new Harness.Platform.FileStoreFolder("fileStoreFolderResource", new()
{
    Identifier = "string",
    ParentIdentifier = "string",
    Description = "string",
    Name = "string",
    OrgId = "string",
    ProjectId = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := platform.NewFileStoreFolder(ctx, "fileStoreFolderResource", &platform.FileStoreFolderArgs{
	Identifier:       pulumi.String("string"),
	ParentIdentifier: pulumi.String("string"),
	Description:      pulumi.String("string"),
	Name:             pulumi.String("string"),
	OrgId:            pulumi.String("string"),
	ProjectId:        pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var fileStoreFolderResource = new FileStoreFolder("fileStoreFolderResource", FileStoreFolderArgs.builder()
    .identifier("string")
    .parentIdentifier("string")
    .description("string")
    .name("string")
    .orgId("string")
    .projectId("string")
    .tags("string")
    .build());

    file_store_folder_resource = harness.platform.FileStoreFolder("fileStoreFolderResource",
    identifier="string",
    parent_identifier="string",
    description="string",
    name="string",
    org_id="string",
    project_id="string",
    tags=["string"])

    const fileStoreFolderResource = new harness.platform.FileStoreFolder("fileStoreFolderResource", {
    identifier: "string",
    parentIdentifier: "string",
    description: "string",
    name: "string",
    orgId: "string",
    projectId: "string",
    tags: ["string"],
});

    type: harness:platform:FileStoreFolder
properties:
    description: string
    identifier: string
    name: string
    orgId: string
    parentIdentifier: string
    projectId: string
    tags:
        - string

    FileStoreFolder 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 FileStoreFolder resource accepts the following input properties:

    Identifier string
    Unique identifier of the resource.
    ParentIdentifier string
    Folder parent identifier on Harness File Store. If the file is at the root level, the parent_identifier will be Root.
    Description string
    Description of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    Identifier string
    Unique identifier of the resource.
    ParentIdentifier string
    Folder parent identifier on Harness File Store. If the file is at the root level, the parent_identifier will be Root.
    Description string
    Description of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    identifier String
    Unique identifier of the resource.
    parentIdentifier String
    Folder parent identifier on Harness File Store. If the file is at the root level, the parent_identifier will be Root.
    description String
    Description of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    identifier string
    Unique identifier of the resource.
    parentIdentifier string
    Folder parent identifier on Harness File Store. If the file is at the root level, the parent_identifier will be Root.
    description string
    Description of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    identifier str
    Unique identifier of the resource.
    parent_identifier str
    Folder parent identifier on Harness File Store. If the file is at the root level, the parent_identifier will be Root.
    description str
    Description of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    identifier String
    Unique identifier of the resource.
    parentIdentifier String
    Folder parent identifier on Harness File Store. If the file is at the root level, the parent_identifier will be Root.
    description String
    Description of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.

    Outputs

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

    CreatedBies List<FileStoreFolderCreatedBy>
    Created by
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt int
    Last modified at
    LastModifiedBies List<FileStoreFolderLastModifiedBy>
    Last modified by
    Path string
    Harness File Store folder path
    CreatedBies []FileStoreFolderCreatedBy
    Created by
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt int
    Last modified at
    LastModifiedBies []FileStoreFolderLastModifiedBy
    Last modified by
    Path string
    Harness File Store folder path
    createdBies List<FileStoreFolderCreatedBy>
    Created by
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt Integer
    Last modified at
    lastModifiedBies List<FileStoreFolderLastModifiedBy>
    Last modified by
    path String
    Harness File Store folder path
    createdBies FileStoreFolderCreatedBy[]
    Created by
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt number
    Last modified at
    lastModifiedBies FileStoreFolderLastModifiedBy[]
    Last modified by
    path string
    Harness File Store folder path
    created_bies Sequence[FileStoreFolderCreatedBy]
    Created by
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_at int
    Last modified at
    last_modified_bies Sequence[FileStoreFolderLastModifiedBy]
    Last modified by
    path str
    Harness File Store folder path
    createdBies List<Property Map>
    Created by
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt Number
    Last modified at
    lastModifiedBies List<Property Map>
    Last modified by
    path String
    Harness File Store folder path

    Look up Existing FileStoreFolder Resource

    Get an existing FileStoreFolder 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?: FileStoreFolderState, opts?: CustomResourceOptions): FileStoreFolder
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_bies: Optional[Sequence[FileStoreFolderCreatedByArgs]] = None,
        description: Optional[str] = None,
        identifier: Optional[str] = None,
        last_modified_at: Optional[int] = None,
        last_modified_bies: Optional[Sequence[FileStoreFolderLastModifiedByArgs]] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        parent_identifier: Optional[str] = None,
        path: Optional[str] = None,
        project_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> FileStoreFolder
    func GetFileStoreFolder(ctx *Context, name string, id IDInput, state *FileStoreFolderState, opts ...ResourceOption) (*FileStoreFolder, error)
    public static FileStoreFolder Get(string name, Input<string> id, FileStoreFolderState? state, CustomResourceOptions? opts = null)
    public static FileStoreFolder get(String name, Output<String> id, FileStoreFolderState 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:
    CreatedBies List<FileStoreFolderCreatedBy>
    Created by
    Description string
    Description of the resource.
    Identifier string
    Unique identifier of the resource.
    LastModifiedAt int
    Last modified at
    LastModifiedBies List<FileStoreFolderLastModifiedBy>
    Last modified by
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ParentIdentifier string
    Folder parent identifier on Harness File Store. If the file is at the root level, the parent_identifier will be Root.
    Path string
    Harness File Store folder path
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    CreatedBies []FileStoreFolderCreatedByArgs
    Created by
    Description string
    Description of the resource.
    Identifier string
    Unique identifier of the resource.
    LastModifiedAt int
    Last modified at
    LastModifiedBies []FileStoreFolderLastModifiedByArgs
    Last modified by
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ParentIdentifier string
    Folder parent identifier on Harness File Store. If the file is at the root level, the parent_identifier will be Root.
    Path string
    Harness File Store folder path
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    createdBies List<FileStoreFolderCreatedBy>
    Created by
    description String
    Description of the resource.
    identifier String
    Unique identifier of the resource.
    lastModifiedAt Integer
    Last modified at
    lastModifiedBies List<FileStoreFolderLastModifiedBy>
    Last modified by
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    parentIdentifier String
    Folder parent identifier on Harness File Store. If the file is at the root level, the parent_identifier will be Root.
    path String
    Harness File Store folder path
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    createdBies FileStoreFolderCreatedBy[]
    Created by
    description string
    Description of the resource.
    identifier string
    Unique identifier of the resource.
    lastModifiedAt number
    Last modified at
    lastModifiedBies FileStoreFolderLastModifiedBy[]
    Last modified by
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    parentIdentifier string
    Folder parent identifier on Harness File Store. If the file is at the root level, the parent_identifier will be Root.
    path string
    Harness File Store folder path
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    created_bies Sequence[FileStoreFolderCreatedByArgs]
    Created by
    description str
    Description of the resource.
    identifier str
    Unique identifier of the resource.
    last_modified_at int
    Last modified at
    last_modified_bies Sequence[FileStoreFolderLastModifiedByArgs]
    Last modified by
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    parent_identifier str
    Folder parent identifier on Harness File Store. If the file is at the root level, the parent_identifier will be Root.
    path str
    Harness File Store folder path
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    createdBies List<Property Map>
    Created by
    description String
    Description of the resource.
    identifier String
    Unique identifier of the resource.
    lastModifiedAt Number
    Last modified at
    lastModifiedBies List<Property Map>
    Last modified by
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    parentIdentifier String
    Folder parent identifier on Harness File Store. If the file is at the root level, the parent_identifier will be Root.
    path String
    Harness File Store folder path
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.

    Supporting Types

    FileStoreFolderCreatedBy, FileStoreFolderCreatedByArgs

    Email string
    User email
    Name string
    User name
    Email string
    User email
    Name string
    User name
    email String
    User email
    name String
    User name
    email string
    User email
    name string
    User name
    email str
    User email
    name str
    User name
    email String
    User email
    name String
    User name

    FileStoreFolderLastModifiedBy, FileStoreFolderLastModifiedByArgs

    Email string
    User email
    Name string
    User name
    Email string
    User email
    Name string
    User name
    email String
    User email
    name String
    User name
    email string
    User email
    name string
    User name
    email str
    User email
    name str
    User name
    email String
    User email
    name String
    User name

    Import

    Import account level folder

    $ pulumi import harness:platform/fileStoreFolder:FileStoreFolder example <identifier>

    Import org level folder

    $ pulumi import harness:platform/fileStoreFolder:FileStoreFolder example <org_id>/<identifier>

    Import org level folder

    $ pulumi import harness:platform/fileStoreFolder:FileStoreFolder example <org_id>/<project_id>/<identifier>

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

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
    pulumi/pulumi-harness