1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. Folder
CockroachDB v0.2.2 published on Monday, Mar 11, 2024 by pulumiverse

cockroach.Folder

Explore with Pulumi AI

cockroach logo
CockroachDB v0.2.2 published on Monday, Mar 11, 2024 by pulumiverse

    CockroachDB Cloud folder.

    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,
               name: Optional[str] = None,
               parent_id: 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: cockroach: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 Cockroach.Folder("folderResource", new()
    {
        Name = "string",
        ParentId = "string",
    });
    
    example, err := cockroach.NewFolder(ctx, "folderResource", &cockroach.FolderArgs{
    	Name:     pulumi.String("string"),
    	ParentId: pulumi.String("string"),
    })
    
    var folderResource = new Folder("folderResource", FolderArgs.builder()        
        .name("string")
        .parentId("string")
        .build());
    
    folder_resource = cockroach.Folder("folderResource",
        name="string",
        parent_id="string")
    
    const folderResource = new cockroach.Folder("folderResource", {
        name: "string",
        parentId: "string",
    });
    
    type: cockroach:Folder
    properties:
        name: string
        parentId: 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:

    Name string
    Name of the folder.
    ParentId string
    ID of the parent folder. Use 'root' for the root level (no parent folder).
    Name string
    Name of the folder.
    ParentId string
    ID of the parent folder. Use 'root' for the root level (no parent folder).
    name String
    Name of the folder.
    parentId String
    ID of the parent folder. Use 'root' for the root level (no parent folder).
    name string
    Name of the folder.
    parentId string
    ID of the parent folder. Use 'root' for the root level (no parent folder).
    name str
    Name of the folder.
    parent_id str
    ID of the parent folder. Use 'root' for the root level (no parent folder).
    name String
    Name of the folder.
    parentId String
    ID of the parent folder. Use 'root' for the root level (no parent folder).

    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.
    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 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,
            name: Optional[str] = None,
            parent_id: 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:
    Name string
    Name of the folder.
    ParentId string
    ID of the parent folder. Use 'root' for the root level (no parent folder).
    Name string
    Name of the folder.
    ParentId string
    ID of the parent folder. Use 'root' for the root level (no parent folder).
    name String
    Name of the folder.
    parentId String
    ID of the parent folder. Use 'root' for the root level (no parent folder).
    name string
    Name of the folder.
    parentId string
    ID of the parent folder. Use 'root' for the root level (no parent folder).
    name str
    Name of the folder.
    parent_id str
    ID of the parent folder. Use 'root' for the root level (no parent folder).
    name String
    Name of the folder.
    parentId String
    ID of the parent folder. Use 'root' for the root level (no parent folder).

    Package Details

    Repository
    cockroach pulumiverse/pulumi-cockroach
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cockroach Terraform Provider.
    cockroach logo
    CockroachDB v0.2.2 published on Monday, Mar 11, 2024 by pulumiverse