@maienm/pulumi-prowlarr
Version:
A Pulumi package for creating and managing Prowlarr resources. Based on terraform-provider-prowlarr: version v2.3.0
194 lines (193 loc) • 5.06 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* <!-- subcategory:Download Clients -->Download Client Nzbvortex resource.
* For more information refer to [Download Client](https://wiki.servarr.com/prowlarr/settings#download-clients) and [Nzbvortex](https://wiki.servarr.com/prowlarr/supported#nzbvortex).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as prowlarr from "@maienm/pulumi-prowlarr";
*
* const example = new prowlarr.downloadclients.Nzbvortex("example", {
* enable: true,
* host: "nzbvortex",
* port: 6789,
* priority: 1,
* urlBase: "/nzbvortex/",
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import prowlarr: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>;
/**
* List of categories.
*/
readonly categories: pulumi.Output<outputs.DownloadClients.NzbvortexCategory[]>;
/**
* Category.
*/
readonly category: pulumi.Output<string>;
/**
* Enable flag.
*/
readonly enable: pulumi.Output<boolean>;
/**
* host.
*/
readonly host: pulumi.Output<string>;
/**
* Recent Movie priority. `-1` Low, `0` Normal, `1` High.
*/
readonly itemPriority: pulumi.Output<number>;
/**
* Name of client category.
*/
readonly name: 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>;
/**
* 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>;
/**
* List of categories.
*/
categories?: pulumi.Input<pulumi.Input<inputs.DownloadClients.NzbvortexCategory>[]>;
/**
* Category.
*/
category?: pulumi.Input<string>;
/**
* Enable flag.
*/
enable?: pulumi.Input<boolean>;
/**
* host.
*/
host?: pulumi.Input<string>;
/**
* Recent Movie priority. `-1` Low, `0` Normal, `1` High.
*/
itemPriority?: pulumi.Input<number>;
/**
* Name of client category.
*/
name?: 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>;
}
/**
* The set of arguments for constructing a Nzbvortex resource.
*/
export interface NzbvortexArgs {
/**
* 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. `-1` Low, `0` Normal, `1` High.
*/
itemPriority?: pulumi.Input<number>;
/**
* Name of client category.
*/
name?: 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>;
}