UNPKG

@pulumiverse/cockroach

Version:

A Pulumi package to create and managed Cockroach DB resources in Pulumi programs.

88 lines (87 loc) 2.75 kB
import * as pulumi from "@pulumi/pulumi"; /** * CockroachDB Cloud folder. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as cockroach from "@pulumiverse/cockroach"; * * const aTeam = new cockroach.Folder("a_team", { * name: "a-team", * parentId: "root", * }); * const aTeamDev = new cockroach.Folder("a_team_dev", { * name: "dev", * parentId: aTeam.id, * }); * ``` * * ## Import * * format: <folder id> * * ```sh * $ pulumi import cockroach:index/folder:Folder my_folder 1f69fdd2-600a-4cfc-a9ba-16995df0d77d * ``` */ export declare class Folder extends pulumi.CustomResource { /** * Get an existing Folder resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FolderState, opts?: pulumi.CustomResourceOptions): Folder; /** * Returns true if the given object is an instance of Folder. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Folder; /** * Name of the folder. */ readonly name: pulumi.Output<string>; /** * ID of the parent folder. Use 'root' for the root level (no parent folder). */ readonly parentId: pulumi.Output<string>; /** * Create a Folder resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: FolderArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Folder resources. */ export interface FolderState { /** * Name of the folder. */ name?: pulumi.Input<string>; /** * ID of the parent folder. Use 'root' for the root level (no parent folder). */ parentId?: pulumi.Input<string>; } /** * The set of arguments for constructing a Folder resource. */ export interface FolderArgs { /** * Name of the folder. */ name?: pulumi.Input<string>; /** * ID of the parent folder. Use 'root' for the root level (no parent folder). */ parentId: pulumi.Input<string>; }