UNPKG

@maienm/pulumi-readarr

Version:

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

220 lines (219 loc) 5.78 kB
import * as pulumi from "@pulumi/pulumi"; /** * <!-- subcategory:Download Clients -->Download Client Nzbvortex resource. * For more information refer to [Download Client](https://wiki.servarr.com/readarr/settings#download-clients) and [Nzbvortex](https://wiki.servarr.com/readarr/supported#nzbvortex). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as readarr from "@maienm/pulumi-readarr"; * * const example = new readarr.downloadclients.Nzbvortex("example", { * enable: true, * host: "nzbvortex", * port: 6789, * priority: 1, * urlBase: "/nzbvortex/", * }); * ``` * * ## Import * * import using the API/UI ID * * ```sh * $ pulumi import readarr:DownloadClients/nzbvortex:Nzbvortex example 1 * ``` */ export declare class Nzbvortex extends pulumi.CustomResource { /** * Get an existing Nzbvortex 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?: NzbvortexState, opts?: pulumi.CustomResourceOptions): Nzbvortex; /** * Returns true if the given object is an instance of Nzbvortex. 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 Nzbvortex; /** * API key. */ readonly apiKey: pulumi.Output<string>; /** * Book category. */ readonly bookCategory: pulumi.Output<string>; /** * Enable flag. */ readonly enable: pulumi.Output<boolean>; /** * host. */ readonly host: pulumi.Output<string>; /** * Download Client name. */ readonly name: pulumi.Output<string>; /** * Older Music priority. `-1` Low, `0` Normal, `1` High. */ readonly olderBookPriority: pulumi.Output<number>; /** * Port. */ readonly port: pulumi.Output<number>; /** * Priority. */ readonly priority: pulumi.Output<number>; /** * Recent Music priority. `-1` Low, `0` Normal, `1` High. */ readonly recentBookPriority: pulumi.Output<number>; /** * Remove completed downloads flag. */ readonly removeCompletedDownloads: pulumi.Output<boolean>; /** * Remove failed downloads flag. */ readonly removeFailedDownloads: pulumi.Output<boolean>; /** * List of associated tags. */ readonly tags: pulumi.Output<number[]>; /** * Base URL. */ readonly urlBase: pulumi.Output<string>; /** * Create a Nzbvortex 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: NzbvortexArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Nzbvortex resources. */ export interface NzbvortexState { /** * API key. */ apiKey?: pulumi.Input<string>; /** * Book category. */ bookCategory?: pulumi.Input<string>; /** * Enable flag. */ enable?: pulumi.Input<boolean>; /** * host. */ host?: pulumi.Input<string>; /** * Download Client name. */ name?: pulumi.Input<string>; /** * Older Music priority. `-1` Low, `0` Normal, `1` High. */ olderBookPriority?: pulumi.Input<number>; /** * Port. */ port?: pulumi.Input<number>; /** * Priority. */ priority?: pulumi.Input<number>; /** * Recent Music priority. `-1` Low, `0` Normal, `1` High. */ recentBookPriority?: pulumi.Input<number>; /** * Remove completed downloads flag. */ removeCompletedDownloads?: pulumi.Input<boolean>; /** * Remove failed downloads flag. */ removeFailedDownloads?: pulumi.Input<boolean>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; /** * Base URL. */ urlBase?: pulumi.Input<string>; } /** * The set of arguments for constructing a Nzbvortex resource. */ export interface NzbvortexArgs { /** * API key. */ apiKey: pulumi.Input<string>; /** * Book category. */ bookCategory?: pulumi.Input<string>; /** * Enable flag. */ enable?: pulumi.Input<boolean>; /** * host. */ host?: pulumi.Input<string>; /** * Download Client name. */ name?: pulumi.Input<string>; /** * Older Music priority. `-1` Low, `0` Normal, `1` High. */ olderBookPriority?: pulumi.Input<number>; /** * Port. */ port?: pulumi.Input<number>; /** * Priority. */ priority?: pulumi.Input<number>; /** * Recent Music priority. `-1` Low, `0` Normal, `1` High. */ recentBookPriority?: pulumi.Input<number>; /** * Remove completed downloads flag. */ removeCompletedDownloads?: pulumi.Input<boolean>; /** * Remove failed downloads flag. */ removeFailedDownloads?: pulumi.Input<boolean>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; /** * Base URL. */ urlBase?: pulumi.Input<string>; }