@pulumi/scm/folder.d.ts

A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1

import * as pulumi from "@pulumi/pulumi";
/**
 * Folder resource
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scm from "@pulumi/scm";
 *
 * //
 * // Creates a folder under the "All Firewalls" aka "ngfw-shared" folder
 * //
 * const scmFolderExample = new scm.Folder("scm_folder_example", {
 *     name: "scm_folder_example",
 *     parent: "ngfw-shared",
 *     description: "Managed by Pulumi",
 * });
 * //
 * // Creates a folder under the "scm_folder_example" folder created beforehand
 * //
 * const scmNestedFolderExample = new scm.Folder("scm_nested_folder_example", {
 *     name: "scm_nested_folder_example",
 *     parent: "scm_folder_example",
 *     description: "Managed by Pulumi",
 * }, {
 *     dependsOn: [scmFolderExample],
 * });
 * //
 * // Creates a snippet that will be associated to a folder
 * //
 * const scmSnippetExample = new scm.Snippet("scm_snippet_example", {
 *     name: "scm_snippet_example",
 *     description: "Managed by Pulumi",
 * });
 * //
 * // Creates a folder with an attached snippet
 * //
 * const scmFolderWithSnippets = new scm.Folder("scm_folder_with_snippets", {
 *     name: "scm_folder_with_snippets",
 *     parent: "ngfw-shared",
 *     description: "Managed by Pulumi",
 *     snippets: [scmSnippetExample.name],
 * });
 * //
 * // Creates a label that will be associated to a folder
 * //
 * const scmLabelExample = new scm.Label("scm_label_example", {
 *     name: "scm_label_example",
 *     description: "Managed by Pulumi",
 * });
 * //
 * // Creates a folder with an attached label
 * //
 * const scmFolderWithLabel = new scm.Folder("scm_folder_with_label", {
 *     name: "scm_folder_with_label",
 *     parent: "ngfw-shared",
 *     description: "Managed by Pulumi",
 *     labels: [scmLabelExample.name],
 * }, {
 *     dependsOn: [scmLabelExample],
 * });
 * ```
 */
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 | undefined>;
    /**
     * Labels assigned to the folder
     */
    readonly labels: pulumi.Output<string[] | undefined>;
    /**
     * The name of the folder
     */
    readonly name: pulumi.Output<string>;
    /**
     * The parent folder
     */
    readonly parent: pulumi.Output<string>;
    /**
     * Snippets associated with the folder
     */
    readonly snippets: pulumi.Output<string[] | undefined>;
    readonly tfid: 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>;
    /**
     * Labels assigned to the folder
     */
    labels?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The name of the folder
     */
    name?: pulumi.Input<string>;
    /**
     * The parent folder
     */
    parent?: pulumi.Input<string>;
    /**
     * Snippets associated with the folder
     */
    snippets?: pulumi.Input<pulumi.Input<string>[]>;
    tfid?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Folder resource.
 */
export interface FolderArgs {
    /**
     * The description of the folder
     */
    description?: pulumi.Input<string>;
    /**
     * Labels assigned to the folder
     */
    labels?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The name of the folder
     */
    name?: pulumi.Input<string>;
    /**
     * The parent folder
     */
    parent: pulumi.Input<string>;
    /**
     * Snippets associated with the folder
     */
    snippets?: pulumi.Input<pulumi.Input<string>[]>;
}