@maienm/pulumi-readarr/mediamanagement/mediaManagement.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 -->Media Management resource.
 * For more information refer to [Naming](https://wiki.servarr.com/readarr/settings#file-management) documentation.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as readarr from "@maienm/pulumi-readarr";
 *
 * const example = new readarr.mediamanagement.MediaManagement("example", {
 *     allowFingerprinting: "never",
 *     chmodFolder: "755",
 *     chownGroup: "arrs",
 *     createEmptyAuthorFolders: true,
 *     deleteEmptyFolders: true,
 *     downloadPropersRepacks: "preferAndUpgrade",
 *     extraFileExtensions: "info",
 *     fileDate: "bookReleaseDate",
 *     hardlinksCopy: true,
 *     importExtraFiles: true,
 *     minimumFreeSpace: 100,
 *     recycleBinDays: 7,
 *     recycleBinPath: "/bin",
 *     rescanAfterRefresh: "always",
 *     setPermissions: true,
 *     skipFreeSpaceCheck: true,
 *     unmonitorPreviousBooks: false,
 *     watchIbraryForChanges: true,
 * });
 * ```
 *
 * ## Import
 *
 * import does not need parameters
 *
 * ```sh
 *  $ pulumi import readarr:MediaManagement/mediaManagement:MediaManagement example ""
 * ```
 */
export declare class MediaManagement extends pulumi.CustomResource {
    /**
     * Get an existing MediaManagement 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?: MediaManagementState, opts?: pulumi.CustomResourceOptions): MediaManagement;
    /**
     * Returns true if the given object is an instance of MediaManagement.  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 MediaManagement;
    /**
     * Allow fingerprinting. valid inputs are: 'newFiles', 'allFiles' and 'never'.
     */
    readonly allowFingerprinting: pulumi.Output<string>;
    /**
     * Permission in linux format.
     */
    readonly chmodFolder: pulumi.Output<string>;
    /**
     * Group used for permission.
     */
    readonly chownGroup: pulumi.Output<string>;
    /**
     * Create empty author directories.
     */
    readonly createEmptyAuthorFolders: pulumi.Output<boolean>;
    /**
     * Delete empty directories.
     */
    readonly deleteEmptyFolders: pulumi.Output<boolean>;
    /**
     * Download proper and repack policy. valid inputs are: 'preferAndUpgrade', 'doNotUpgrade', and 'doNotPrefer'.
     */
    readonly downloadPropersRepacks: pulumi.Output<string>;
    /**
     * Comma separated list of extra files to import (.nfo will be imported as .nfo-orig).
     */
    readonly extraFileExtensions: pulumi.Output<string>;
    /**
     * Define the file date modification. valid inputs are: 'none', and 'bookReleaseDate'.
     */
    readonly fileDate: pulumi.Output<string>;
    /**
     * Use hardlinks instead of copy.
     */
    readonly hardlinksCopy: pulumi.Output<boolean>;
    /**
     * Import extra files. If enabled it will leverage 'extra*file*extensions'.
     */
    readonly importExtraFiles: pulumi.Output<boolean>;
    /**
     * Minimum free space in MB to allow import.
     */
    readonly minimumFreeSpace: pulumi.Output<number>;
    /**
     * Recyle bin days of retention.
     */
    readonly recycleBinDays: pulumi.Output<number>;
    /**
     * Recycle bin absolute path.
     */
    readonly recycleBinPath: pulumi.Output<string>;
    /**
     * Rescan after refresh policy. valid inputs are: 'always', 'afterManual' and 'never'.
     */
    readonly rescanAfterRefresh: pulumi.Output<string>;
    /**
     * Set permission for imported files.
     */
    readonly setPermissions: pulumi.Output<boolean>;
    /**
     * Skip free space check before importing.
     */
    readonly skipFreeSpaceCheck: pulumi.Output<boolean>;
    /**
     * Unmonitor deleted files.
     */
    readonly unmonitorPreviousBooks: pulumi.Output<boolean>;
    /**
     * Watch library for changes.
     */
    readonly watchIbraryForChanges: pulumi.Output<boolean>;
    /**
     * Create a MediaManagement 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: MediaManagementArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering MediaManagement resources.
 */
export interface MediaManagementState {
    /**
     * Allow fingerprinting. valid inputs are: 'newFiles', 'allFiles' and 'never'.
     */
    allowFingerprinting?: pulumi.Input<string>;
    /**
     * Permission in linux format.
     */
    chmodFolder?: pulumi.Input<string>;
    /**
     * Group used for permission.
     */
    chownGroup?: pulumi.Input<string>;
    /**
     * Create empty author directories.
     */
    createEmptyAuthorFolders?: pulumi.Input<boolean>;
    /**
     * Delete empty directories.
     */
    deleteEmptyFolders?: pulumi.Input<boolean>;
    /**
     * Download proper and repack policy. valid inputs are: 'preferAndUpgrade', 'doNotUpgrade', and 'doNotPrefer'.
     */
    downloadPropersRepacks?: pulumi.Input<string>;
    /**
     * Comma separated list of extra files to import (.nfo will be imported as .nfo-orig).
     */
    extraFileExtensions?: pulumi.Input<string>;
    /**
     * Define the file date modification. valid inputs are: 'none', and 'bookReleaseDate'.
     */
    fileDate?: pulumi.Input<string>;
    /**
     * Use hardlinks instead of copy.
     */
    hardlinksCopy?: pulumi.Input<boolean>;
    /**
     * Import extra files. If enabled it will leverage 'extra*file*extensions'.
     */
    importExtraFiles?: pulumi.Input<boolean>;
    /**
     * Minimum free space in MB to allow import.
     */
    minimumFreeSpace?: pulumi.Input<number>;
    /**
     * Recyle bin days of retention.
     */
    recycleBinDays?: pulumi.Input<number>;
    /**
     * Recycle bin absolute path.
     */
    recycleBinPath?: pulumi.Input<string>;
    /**
     * Rescan after refresh policy. valid inputs are: 'always', 'afterManual' and 'never'.
     */
    rescanAfterRefresh?: pulumi.Input<string>;
    /**
     * Set permission for imported files.
     */
    setPermissions?: pulumi.Input<boolean>;
    /**
     * Skip free space check before importing.
     */
    skipFreeSpaceCheck?: pulumi.Input<boolean>;
    /**
     * Unmonitor deleted files.
     */
    unmonitorPreviousBooks?: pulumi.Input<boolean>;
    /**
     * Watch library for changes.
     */
    watchIbraryForChanges?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a MediaManagement resource.
 */
export interface MediaManagementArgs {
    /**
     * Allow fingerprinting. valid inputs are: 'newFiles', 'allFiles' and 'never'.
     */
    allowFingerprinting: pulumi.Input<string>;
    /**
     * Permission in linux format.
     */
    chmodFolder: pulumi.Input<string>;
    /**
     * Group used for permission.
     */
    chownGroup: pulumi.Input<string>;
    /**
     * Create empty author directories.
     */
    createEmptyAuthorFolders: pulumi.Input<boolean>;
    /**
     * Delete empty directories.
     */
    deleteEmptyFolders: pulumi.Input<boolean>;
    /**
     * Download proper and repack policy. valid inputs are: 'preferAndUpgrade', 'doNotUpgrade', and 'doNotPrefer'.
     */
    downloadPropersRepacks: pulumi.Input<string>;
    /**
     * Comma separated list of extra files to import (.nfo will be imported as .nfo-orig).
     */
    extraFileExtensions: pulumi.Input<string>;
    /**
     * Define the file date modification. valid inputs are: 'none', and 'bookReleaseDate'.
     */
    fileDate: pulumi.Input<string>;
    /**
     * Use hardlinks instead of copy.
     */
    hardlinksCopy: pulumi.Input<boolean>;
    /**
     * Import extra files. If enabled it will leverage 'extra*file*extensions'.
     */
    importExtraFiles: pulumi.Input<boolean>;
    /**
     * Minimum free space in MB to allow import.
     */
    minimumFreeSpace: pulumi.Input<number>;
    /**
     * Recyle bin days of retention.
     */
    recycleBinDays: pulumi.Input<number>;
    /**
     * Recycle bin absolute path.
     */
    recycleBinPath: pulumi.Input<string>;
    /**
     * Rescan after refresh policy. valid inputs are: 'always', 'afterManual' and 'never'.
     */
    rescanAfterRefresh: pulumi.Input<string>;
    /**
     * Set permission for imported files.
     */
    setPermissions: pulumi.Input<boolean>;
    /**
     * Skip free space check before importing.
     */
    skipFreeSpaceCheck: pulumi.Input<boolean>;
    /**
     * Unmonitor deleted files.
     */
    unmonitorPreviousBooks: pulumi.Input<boolean>;
    /**
     * Watch library for changes.
     */
    watchIbraryForChanges: pulumi.Input<boolean>;
}