1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. dataworks
  5. Folder
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

alicloud.dataworks.Folder

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

    Provides a Data Works Folder resource.

    For information about Data Works Folder and how to use it, see What is Folder.

    NOTE: Available in v1.131.0+.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const example = new alicloud.dataworks.Folder("example", {
        projectId: "320687",
        folderPath: "Business Flow/tfTestAcc/folderDi/tftest1",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    example = alicloud.dataworks.Folder("example",
        project_id="320687",
        folder_path="Business Flow/tfTestAcc/folderDi/tftest1")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dataworks"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dataworks.NewFolder(ctx, "example", &dataworks.FolderArgs{
    			ProjectId:  pulumi.String("320687"),
    			FolderPath: pulumi.String("Business Flow/tfTestAcc/folderDi/tftest1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new AliCloud.DataWorks.Folder("example", new()
        {
            ProjectId = "320687",
            FolderPath = "Business Flow/tfTestAcc/folderDi/tftest1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.dataworks.Folder;
    import com.pulumi.alicloud.dataworks.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 example = new Folder("example", FolderArgs.builder()
                .projectId("320687")
                .folderPath("Business Flow/tfTestAcc/folderDi/tftest1")
                .build());
    
        }
    }
    
    resources:
      example:
        type: alicloud:dataworks:Folder
        properties:
          projectId: '320687'
          folderPath: Business Flow/tfTestAcc/folderDi/tftest1
    

    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,
               folder_path: Optional[str] = None,
               project_id: Optional[str] = None,
               project_identifier: 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: alicloud:dataworks:Folder
    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 FolderArgs
    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 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 string
    The unique name of the resource.
    args FolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FolderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var folderResource = new AliCloud.DataWorks.Folder("folderResource", new()
    {
        FolderPath = "string",
        ProjectId = "string",
        ProjectIdentifier = "string",
    });
    
    example, err := dataworks.NewFolder(ctx, "folderResource", &dataworks.FolderArgs{
    	FolderPath:        pulumi.String("string"),
    	ProjectId:         pulumi.String("string"),
    	ProjectIdentifier: pulumi.String("string"),
    })
    
    var folderResource = new Folder("folderResource", FolderArgs.builder()
        .folderPath("string")
        .projectId("string")
        .projectIdentifier("string")
        .build());
    
    folder_resource = alicloud.dataworks.Folder("folderResource",
        folder_path="string",
        project_id="string",
        project_identifier="string")
    
    const folderResource = new alicloud.dataworks.Folder("folderResource", {
        folderPath: "string",
        projectId: "string",
        projectIdentifier: "string",
    });
    
    type: alicloud:dataworks:Folder
    properties:
        folderPath: string
        projectId: string
        projectIdentifier: string
    

    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

    The Folder resource accepts the following input properties:

    FolderPath string
    Folder Path. The folder path composed with for part: Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}. The first segment of path must be Business Flow, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined. Then the finial part of folder path can be specified in yourself.
    ProjectId string
    The ID of the project.
    ProjectIdentifier string
    FolderPath string
    Folder Path. The folder path composed with for part: Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}. The first segment of path must be Business Flow, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined. Then the finial part of folder path can be specified in yourself.
    ProjectId string
    The ID of the project.
    ProjectIdentifier string
    folderPath String
    Folder Path. The folder path composed with for part: Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}. The first segment of path must be Business Flow, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined. Then the finial part of folder path can be specified in yourself.
    projectId String
    The ID of the project.
    projectIdentifier String
    folderPath string
    Folder Path. The folder path composed with for part: Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}. The first segment of path must be Business Flow, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined. Then the finial part of folder path can be specified in yourself.
    projectId string
    The ID of the project.
    projectIdentifier string
    folder_path str
    Folder Path. The folder path composed with for part: Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}. The first segment of path must be Business Flow, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined. Then the finial part of folder path can be specified in yourself.
    project_id str
    The ID of the project.
    project_identifier str
    folderPath String
    Folder Path. The folder path composed with for part: Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}. The first segment of path must be Business Flow, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined. Then the finial part of folder path can be specified in yourself.
    projectId String
    The ID of the project.
    projectIdentifier String

    Outputs

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

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

    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,
            folder_id: Optional[str] = None,
            folder_path: Optional[str] = None,
            project_id: Optional[str] = None,
            project_identifier: 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)
    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:
    FolderId string
    FolderPath string
    Folder Path. The folder path composed with for part: Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}. The first segment of path must be Business Flow, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined. Then the finial part of folder path can be specified in yourself.
    ProjectId string
    The ID of the project.
    ProjectIdentifier string
    FolderId string
    FolderPath string
    Folder Path. The folder path composed with for part: Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}. The first segment of path must be Business Flow, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined. Then the finial part of folder path can be specified in yourself.
    ProjectId string
    The ID of the project.
    ProjectIdentifier string
    folderId String
    folderPath String
    Folder Path. The folder path composed with for part: Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}. The first segment of path must be Business Flow, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined. Then the finial part of folder path can be specified in yourself.
    projectId String
    The ID of the project.
    projectIdentifier String
    folderId string
    folderPath string
    Folder Path. The folder path composed with for part: Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}. The first segment of path must be Business Flow, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined. Then the finial part of folder path can be specified in yourself.
    projectId string
    The ID of the project.
    projectIdentifier string
    folder_id str
    folder_path str
    Folder Path. The folder path composed with for part: Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}. The first segment of path must be Business Flow, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined. Then the finial part of folder path can be specified in yourself.
    project_id str
    The ID of the project.
    project_identifier str
    folderId String
    folderPath String
    Folder Path. The folder path composed with for part: Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}. The first segment of path must be Business Flow, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined. Then the finial part of folder path can be specified in yourself.
    projectId String
    The ID of the project.
    projectIdentifier String

    Import

    Data Works Folder can be imported using the id, e.g.

    $ pulumi import alicloud:dataworks/folder:Folder example <folder_id>:<$.ProjectId>
    

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi