@maienm/pulumi-readarr/mediamanagement/rootFolder.d.ts

A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0

import * as pulumi from "@pulumi/pulumi";
/**
 * <!-- subcategory:Media Management -->Root Folder resource.
 * For more information refer to [Root Folders](https://wiki.servarr.com/readarr/settings#root-folders) documentation.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as readarr from "@maienm/pulumi-readarr";
 *
 * const example = new readarr.mediamanagement.RootFolder("example", {
 *     defaultMetadataProfileId: 1,
 *     defaultMonitorOption: "all",
 *     defaultQualityProfileId: 1,
 *     isCalibreLibrary: false,
 *     outputProfile: "default",
 *     path: "/example",
 * });
 * // with calibre
 * const calibreExample = new readarr.mediamanagement.RootFolder("calibreExample", {
 *     defaultMetadataProfileId: 1,
 *     defaultMonitorOption: "all",
 *     defaultQualityProfileId: 1,
 *     host: "calibre-host",
 *     isCalibreLibrary: true,
 *     library: "Calibre_Library",
 *     outputProfile: "default",
 *     password: "Pass",
 *     path: "/calibre",
 *     port: 8081,
 *     useSsl: false,
 *     username: "User",
 * });
 * ```
 *
 * ## Import
 *
 * import using the API/UI ID
 *
 * ```sh
 *  $ pulumi import readarr:MediaManagement/rootFolder:RootFolder example 10
 * ```
 */
export declare class RootFolder extends pulumi.CustomResource {
    /**
     * Get an existing RootFolder 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?: RootFolderState, opts?: pulumi.CustomResourceOptions): RootFolder;
    /**
     * Returns true if the given object is an instance of RootFolder.  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 RootFolder;
    /**
     * Access flag.
     */
    readonly accessible: pulumi.Output<boolean>;
    /**
     * Default metadata profile ID.
     */
    readonly defaultMetadataProfileId: pulumi.Output<number>;
    /**
     * Default monitor new item option.
     */
    readonly defaultMonitorNewItemOption: pulumi.Output<string>;
    /**
     * Default monitor option.
     */
    readonly defaultMonitorOption: pulumi.Output<string>;
    /**
     * Default metadata profile ID.
     */
    readonly defaultQualityProfileId: pulumi.Output<number>;
    /**
     * List of associated tags.
     */
    readonly defaultTags: pulumi.Output<number[]>;
    /**
     * Calibre host.
     */
    readonly host: pulumi.Output<string>;
    /**
     * Is calibre library flag.
     */
    readonly isCalibreLibrary: pulumi.Output<boolean>;
    /**
     * Calibre library.
     */
    readonly library: pulumi.Output<string>;
    /**
     * Root Folder name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Calibre output profile.
     */
    readonly outputProfile: pulumi.Output<string>;
    /**
     * Calibre password.
     */
    readonly password: pulumi.Output<string>;
    /**
     * Root Folder absolute path.
     */
    readonly path: pulumi.Output<string>;
    /**
     * Calibre Port.
     */
    readonly port: pulumi.Output<number>;
    /**
     * Use SSL for calibre connection.
     */
    readonly useSsl: pulumi.Output<boolean>;
    /**
     * Calibre username.
     */
    readonly username: pulumi.Output<string>;
    /**
     * Create a RootFolder 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: RootFolderArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering RootFolder resources.
 */
export interface RootFolderState {
    /**
     * Access flag.
     */
    accessible?: pulumi.Input<boolean>;
    /**
     * Default metadata profile ID.
     */
    defaultMetadataProfileId?: pulumi.Input<number>;
    /**
     * Default monitor new item option.
     */
    defaultMonitorNewItemOption?: pulumi.Input<string>;
    /**
     * Default monitor option.
     */
    defaultMonitorOption?: pulumi.Input<string>;
    /**
     * Default metadata profile ID.
     */
    defaultQualityProfileId?: pulumi.Input<number>;
    /**
     * List of associated tags.
     */
    defaultTags?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Calibre host.
     */
    host?: pulumi.Input<string>;
    /**
     * Is calibre library flag.
     */
    isCalibreLibrary?: pulumi.Input<boolean>;
    /**
     * Calibre library.
     */
    library?: pulumi.Input<string>;
    /**
     * Root Folder name.
     */
    name?: pulumi.Input<string>;
    /**
     * Calibre output profile.
     */
    outputProfile?: pulumi.Input<string>;
    /**
     * Calibre password.
     */
    password?: pulumi.Input<string>;
    /**
     * Root Folder absolute path.
     */
    path?: pulumi.Input<string>;
    /**
     * Calibre Port.
     */
    port?: pulumi.Input<number>;
    /**
     * Use SSL for calibre connection.
     */
    useSsl?: pulumi.Input<boolean>;
    /**
     * Calibre username.
     */
    username?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a RootFolder resource.
 */
export interface RootFolderArgs {
    /**
     * Default metadata profile ID.
     */
    defaultMetadataProfileId: pulumi.Input<number>;
    /**
     * Default monitor new item option.
     */
    defaultMonitorNewItemOption: pulumi.Input<string>;
    /**
     * Default monitor option.
     */
    defaultMonitorOption: pulumi.Input<string>;
    /**
     * Default metadata profile ID.
     */
    defaultQualityProfileId: pulumi.Input<number>;
    /**
     * List of associated tags.
     */
    defaultTags?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Calibre host.
     */
    host?: pulumi.Input<string>;
    /**
     * Is calibre library flag.
     */
    isCalibreLibrary: pulumi.Input<boolean>;
    /**
     * Calibre library.
     */
    library?: pulumi.Input<string>;
    /**
     * Root Folder name.
     */
    name?: pulumi.Input<string>;
    /**
     * Calibre output profile.
     */
    outputProfile?: pulumi.Input<string>;
    /**
     * Calibre password.
     */
    password?: pulumi.Input<string>;
    /**
     * Root Folder absolute path.
     */
    path: pulumi.Input<string>;
    /**
     * Calibre Port.
     */
    port?: pulumi.Input<number>;
    /**
     * Use SSL for calibre connection.
     */
    useSsl?: pulumi.Input<boolean>;
    /**
     * Calibre username.
     */
    username?: pulumi.Input<string>;
}