UNPKG

@pulumi/sumologic

Version:

A Pulumi package for creating and managing sumologic cloud resources.

113 lines (112 loc) 3.86 kB
import * as pulumi from "@pulumi/pulumi"; /** * Provides the ability to create, read, delete, update, and manage of folders. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as sumologic from "@pulumi/sumologic"; * * const folder = new sumologic.Folder("folder", { * name: "test-folder", * description: "A test folder", * parentId: "<personal folder id>", * }); * ``` * * ## Import * * ### Timeouts * * `sumologic_folder` provides the following [Timeouts](/docs/configuration/resources.html#timeouts) configuration options: * * - `delete` - (Default `1 minute`) Used for waiting for the deletion job to be successful * * Additional data provided in state * * - `created_at` - (Computed) When the folder was created. * * - `created_by` - (Computed) Who created the folder. * * - `modified_at` - (Computed) When was the folder last modified. * * - `modified_by` - (Computed) The ID of the user who modified the folder last. * * - `item_type` - (Computed) What the type of the content item is (will obviously be "Folder"). * * - `permissions` - (Computed) List of permissions the user has on the content item. * * - `children` - (Computed) A list of all the content items in the created folder (can be folders or other content items). */ 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; /** * The description of the folder. */ readonly description: pulumi.Output<string>; /** * The name of the folder. This is required, and has to be unique. */ readonly name: pulumi.Output<string>; /** * The ID of the folder in which you want to create the new 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 { /** * The description of the folder. */ description?: pulumi.Input<string>; /** * The name of the folder. This is required, and has to be unique. */ name?: pulumi.Input<string>; /** * The ID of the folder in which you want to create the new folder. */ parentId?: pulumi.Input<string>; } /** * The set of arguments for constructing a Folder resource. */ export interface FolderArgs { /** * The description of the folder. */ description: pulumi.Input<string>; /** * The name of the folder. This is required, and has to be unique. */ name?: pulumi.Input<string>; /** * The ID of the folder in which you want to create the new folder. */ parentId: pulumi.Input<string>; }