UNPKG

@maienm/pulumi-prowlarr

Version:

A Pulumi package for creating and managing Prowlarr resources. Based on terraform-provider-prowlarr: version v2.3.0

231 lines (230 loc) 5.82 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * <!-- subcategory:Download Clients -->Download Client Sabnzbd resource. * For more information refer to [Download Client](https://wiki.servarr.com/prowlarr/settings#download-clients) and [Sabnzbd](https://wiki.servarr.com/prowlarr/supported#sabnzbd). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as prowlarr from "@maienm/pulumi-prowlarr"; * * const example = new prowlarr.downloadclients.Sabnzbd("example", { * apiKey: "test", * enable: true, * host: "sabnzbd", * port: 9091, * priority: 1, * urlBase: "/sabnzbd/", * }); * ``` * * ## Import * * import using the API/UI ID * * ```sh * $ pulumi import prowlarr:DownloadClients/sabnzbd:Sabnzbd example 1 * ``` */ export declare class Sabnzbd extends pulumi.CustomResource { /** * Get an existing Sabnzbd 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?: SabnzbdState, opts?: pulumi.CustomResourceOptions): Sabnzbd; /** * Returns true if the given object is an instance of Sabnzbd. 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 Sabnzbd; /** * API key. */ readonly apiKey: pulumi.Output<string>; /** * List of categories. */ readonly categories: pulumi.Output<outputs.DownloadClients.SabnzbdCategory[]>; /** * Category. */ readonly category: pulumi.Output<string>; /** * Enable flag. */ readonly enable: pulumi.Output<boolean>; /** * host. */ readonly host: pulumi.Output<string>; /** * Recent Movie priority. `-100` Default, `-2` Paused, `-1` Low, `0` Normal, `1` High, `2` Force. */ readonly itemPriority: pulumi.Output<number>; /** * Name of client category. */ readonly name: pulumi.Output<string>; /** * Password. */ readonly password: pulumi.Output<string>; /** * Port. */ readonly port: pulumi.Output<number>; /** * Priority. */ readonly priority: pulumi.Output<number>; /** * List of associated tags. */ readonly tags: pulumi.Output<number[]>; /** * Base URL. */ readonly urlBase: pulumi.Output<string>; /** * Use SSL flag. */ readonly useSsl: pulumi.Output<boolean>; /** * Username. */ readonly username: pulumi.Output<string>; /** * Create a Sabnzbd 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?: SabnzbdArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Sabnzbd resources. */ export interface SabnzbdState { /** * API key. */ apiKey?: pulumi.Input<string>; /** * List of categories. */ categories?: pulumi.Input<pulumi.Input<inputs.DownloadClients.SabnzbdCategory>[]>; /** * Category. */ category?: pulumi.Input<string>; /** * Enable flag. */ enable?: pulumi.Input<boolean>; /** * host. */ host?: pulumi.Input<string>; /** * Recent Movie priority. `-100` Default, `-2` Paused, `-1` Low, `0` Normal, `1` High, `2` Force. */ itemPriority?: pulumi.Input<number>; /** * Name of client category. */ name?: pulumi.Input<string>; /** * Password. */ password?: pulumi.Input<string>; /** * Port. */ port?: pulumi.Input<number>; /** * Priority. */ priority?: pulumi.Input<number>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; /** * Base URL. */ urlBase?: pulumi.Input<string>; /** * Use SSL flag. */ useSsl?: pulumi.Input<boolean>; /** * Username. */ username?: pulumi.Input<string>; } /** * The set of arguments for constructing a Sabnzbd resource. */ export interface SabnzbdArgs { /** * API key. */ apiKey?: pulumi.Input<string>; /** * Category. */ category?: pulumi.Input<string>; /** * Enable flag. */ enable?: pulumi.Input<boolean>; /** * host. */ host?: pulumi.Input<string>; /** * Recent Movie priority. `-100` Default, `-2` Paused, `-1` Low, `0` Normal, `1` High, `2` Force. */ itemPriority?: pulumi.Input<number>; /** * Name of client category. */ name?: pulumi.Input<string>; /** * Password. */ password?: pulumi.Input<string>; /** * Port. */ port?: pulumi.Input<number>; /** * Priority. */ priority?: pulumi.Input<number>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; /** * Base URL. */ urlBase?: pulumi.Input<string>; /** * Use SSL flag. */ useSsl?: pulumi.Input<boolean>; /** * Username. */ username?: pulumi.Input<string>; }