@maienm/pulumi-lidarr
Version:
A Pulumi package for creating and managing Lidarr resources. Based on terraform-provider-lidarr: version v1.11.0
256 lines (255 loc) • 6.71 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Download Clients -->Download Client NZBGet resource.
* For more information refer to [Download Client](https://wiki.servarr.com/lidarr/settings#download-clients) and [NZBGet](https://wiki.servarr.com/lidarr/supported#nzbget).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as lidarr from "@maienm/pulumi-lidarr";
*
* const example = new lidarr.downloadclients.Nzbget("example", {
* enable: true,
* host: "nzbget",
* port: 6789,
* priority: 1,
* urlBase: "/nzbget/",
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import lidarr:DownloadClients/nzbget:Nzbget example 1
* ```
*/
export declare class Nzbget extends pulumi.CustomResource {
/**
* Get an existing Nzbget 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?: NzbgetState, opts?: pulumi.CustomResourceOptions): Nzbget;
/**
* Returns true if the given object is an instance of Nzbget. 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 Nzbget;
/**
* Add paused flag.
*/
readonly addPaused: pulumi.Output<boolean>;
/**
* Enable flag.
*/
readonly enable: pulumi.Output<boolean>;
/**
* host.
*/
readonly host: pulumi.Output<string>;
/**
* Music category.
*/
readonly musicCategory: pulumi.Output<string>;
/**
* Download Client name.
*/
readonly name: pulumi.Output<string>;
/**
* Older Music priority. `-100` VeryLow, `-50` Low, `0` Normal, `50` High, `100` VeryHigh, `900` Force.
*/
readonly olderMusicPriority: pulumi.Output<number>;
/**
* Password.
*/
readonly password: pulumi.Output<string>;
/**
* Port.
*/
readonly port: pulumi.Output<number>;
/**
* Priority.
*/
readonly priority: pulumi.Output<number>;
/**
* Recent Music priority. `-100` VeryLow, `-50` Low, `0` Normal, `50` High, `100` VeryHigh, `900` Force.
*/
readonly recentMusicPriority: 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>;
/**
* Use SSL flag.
*/
readonly useSsl: pulumi.Output<boolean>;
/**
* Username.
*/
readonly username: pulumi.Output<string>;
/**
* Create a Nzbget 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?: NzbgetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Nzbget resources.
*/
export interface NzbgetState {
/**
* Add paused flag.
*/
addPaused?: pulumi.Input<boolean>;
/**
* Enable flag.
*/
enable?: pulumi.Input<boolean>;
/**
* host.
*/
host?: pulumi.Input<string>;
/**
* Music category.
*/
musicCategory?: pulumi.Input<string>;
/**
* Download Client name.
*/
name?: pulumi.Input<string>;
/**
* Older Music priority. `-100` VeryLow, `-50` Low, `0` Normal, `50` High, `100` VeryHigh, `900` Force.
*/
olderMusicPriority?: pulumi.Input<number>;
/**
* Password.
*/
password?: pulumi.Input<string>;
/**
* Port.
*/
port?: pulumi.Input<number>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Recent Music priority. `-100` VeryLow, `-50` Low, `0` Normal, `50` High, `100` VeryHigh, `900` Force.
*/
recentMusicPriority?: 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>;
/**
* Use SSL flag.
*/
useSsl?: pulumi.Input<boolean>;
/**
* Username.
*/
username?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Nzbget resource.
*/
export interface NzbgetArgs {
/**
* Add paused flag.
*/
addPaused?: pulumi.Input<boolean>;
/**
* Enable flag.
*/
enable?: pulumi.Input<boolean>;
/**
* host.
*/
host?: pulumi.Input<string>;
/**
* Music category.
*/
musicCategory?: pulumi.Input<string>;
/**
* Download Client name.
*/
name?: pulumi.Input<string>;
/**
* Older Music priority. `-100` VeryLow, `-50` Low, `0` Normal, `50` High, `100` VeryHigh, `900` Force.
*/
olderMusicPriority?: pulumi.Input<number>;
/**
* Password.
*/
password?: pulumi.Input<string>;
/**
* Port.
*/
port?: pulumi.Input<number>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Recent Music priority. `-100` VeryLow, `-50` Low, `0` Normal, `50` High, `100` VeryHigh, `900` Force.
*/
recentMusicPriority?: 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>;
/**
* Use SSL flag.
*/
useSsl?: pulumi.Input<boolean>;
/**
* Username.
*/
username?: pulumi.Input<string>;
}