@maienm/pulumi-readarr/downloadclients/torrentBlackhole.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:Download Clients -->Download Client Torrent Blackhole resource.
 * For more information refer to [Download Client](https://wiki.servarr.com/readarr/settings#download-clients) and [TorrentBlackhole](https://wiki.servarr.com/readarr/supported#torrentblackhole).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as readarr from "@maienm/pulumi-readarr";
 *
 * const example = new readarr.downloadclients.TorrentBlackhole("example", {
 *     enable: true,
 *     magnetFileExtension: ".magnet",
 *     priority: 1,
 *     torrentFolder: "/torrent/",
 *     watchFolder: "/watch/",
 * });
 * ```
 *
 * ## Import
 *
 * import using the API/UI ID
 *
 * ```sh
 *  $ pulumi import readarr:DownloadClients/torrentBlackhole:TorrentBlackhole example 1
 * ```
 */
export declare class TorrentBlackhole extends pulumi.CustomResource {
    /**
     * Get an existing TorrentBlackhole 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?: TorrentBlackholeState, opts?: pulumi.CustomResourceOptions): TorrentBlackhole;
    /**
     * Returns true if the given object is an instance of TorrentBlackhole.  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 TorrentBlackhole;
    /**
     * Enable flag.
     */
    readonly enable: pulumi.Output<boolean>;
    /**
     * Magnet file extension.
     */
    readonly magnetFileExtension: pulumi.Output<string>;
    /**
     * Download Client name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Priority.
     */
    readonly priority: pulumi.Output<number>;
    /**
     * Read only flag.
     */
    readonly readOnly: pulumi.Output<boolean>;
    /**
     * Remove completed downloads flag.
     */
    readonly removeCompletedDownloads: pulumi.Output<boolean>;
    /**
     * Remove failed downloads flag.
     */
    readonly removeFailedDownloads: pulumi.Output<boolean>;
    /**
     * Save magnet files flag.
     */
    readonly saveMagnetFiles: pulumi.Output<boolean>;
    /**
     * List of associated tags.
     */
    readonly tags: pulumi.Output<number[]>;
    /**
     * Torrent folder.
     */
    readonly torrentFolder: pulumi.Output<string>;
    /**
     * Watch folder flag.
     */
    readonly watchFolder: pulumi.Output<string>;
    /**
     * Create a TorrentBlackhole 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: TorrentBlackholeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering TorrentBlackhole resources.
 */
export interface TorrentBlackholeState {
    /**
     * Enable flag.
     */
    enable?: pulumi.Input<boolean>;
    /**
     * Magnet file extension.
     */
    magnetFileExtension?: pulumi.Input<string>;
    /**
     * Download Client name.
     */
    name?: pulumi.Input<string>;
    /**
     * Priority.
     */
    priority?: pulumi.Input<number>;
    /**
     * Read only flag.
     */
    readOnly?: pulumi.Input<boolean>;
    /**
     * Remove completed downloads flag.
     */
    removeCompletedDownloads?: pulumi.Input<boolean>;
    /**
     * Remove failed downloads flag.
     */
    removeFailedDownloads?: pulumi.Input<boolean>;
    /**
     * Save magnet files flag.
     */
    saveMagnetFiles?: pulumi.Input<boolean>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Torrent folder.
     */
    torrentFolder?: pulumi.Input<string>;
    /**
     * Watch folder flag.
     */
    watchFolder?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a TorrentBlackhole resource.
 */
export interface TorrentBlackholeArgs {
    /**
     * Enable flag.
     */
    enable?: pulumi.Input<boolean>;
    /**
     * Magnet file extension.
     */
    magnetFileExtension?: pulumi.Input<string>;
    /**
     * Download Client name.
     */
    name?: pulumi.Input<string>;
    /**
     * Priority.
     */
    priority?: pulumi.Input<number>;
    /**
     * Read only flag.
     */
    readOnly?: pulumi.Input<boolean>;
    /**
     * Remove completed downloads flag.
     */
    removeCompletedDownloads?: pulumi.Input<boolean>;
    /**
     * Remove failed downloads flag.
     */
    removeFailedDownloads?: pulumi.Input<boolean>;
    /**
     * Save magnet files flag.
     */
    saveMagnetFiles?: pulumi.Input<boolean>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Torrent folder.
     */
    torrentFolder: pulumi.Input<string>;
    /**
     * Watch folder flag.
     */
    watchFolder: pulumi.Input<string>;
}