@maienm/pulumi-lidarr
Version:
A Pulumi package for creating and managing Lidarr resources. Based on terraform-provider-lidarr: version v1.11.0
571 lines (570 loc) • 14 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Download Clients -->Generic Download Client resource. When possible use a specific resource instead.
* For more information refer to [Download Client](https://wiki.servarr.com/lidarr/settings#download-clients).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as lidarr from "@maienm/pulumi-lidarr";
*
* const example = new lidarr.downloadclients.DownloadClient("example", {
* configContract: "TransmissionSettings",
* enable: true,
* host: "transmission",
* implementation: "Transmission",
* port: 9091,
* priority: 1,
* protocol: "torrent",
* urlBase: "/transmission/",
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import lidarr:DownloadClients/downloadClient:DownloadClient example 1
* ```
*/
export declare class DownloadClient extends pulumi.CustomResource {
/**
* Get an existing DownloadClient 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?: DownloadClientState, opts?: pulumi.CustomResourceOptions): DownloadClient;
/**
* Returns true if the given object is an instance of DownloadClient. 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 DownloadClient;
/**
* Add paused flag.
*/
readonly addPaused: pulumi.Output<boolean>;
/**
* Add stopped flag.
*/
readonly addStopped: pulumi.Output<boolean>;
/**
* Additional tags, `0` TitleSlug, `1` Quality, `2` Language, `3` ReleaseGroup, `4` Year, `5` Indexer, `6` Network.
*/
readonly additionalTags: pulumi.Output<number[]>;
/**
* API key.
*/
readonly apiKey: pulumi.Output<string>;
/**
* Category.
*/
readonly category: pulumi.Output<string>;
/**
* DownloadClient configuration template.
*/
readonly configContract: pulumi.Output<string>;
/**
* Destination.
*/
readonly destination: pulumi.Output<string>;
/**
* Enable flag.
*/
readonly enable: pulumi.Output<boolean>;
/**
* Field tags.
*/
readonly fieldTags: pulumi.Output<string[]>;
/**
* First and last flag.
*/
readonly firstAndLast: pulumi.Output<boolean>;
/**
* host.
*/
readonly host: pulumi.Output<string>;
/**
* DownloadClient implementation name.
*/
readonly implementation: pulumi.Output<string>;
/**
* Initial state. `0` Start, `1` ForceStart, `2` Pause.
*/
readonly initialState: pulumi.Output<number>;
/**
* Initial state, with Stop support. `0` Start, `1` ForceStart, `2` Pause, `3` Stop.
*/
readonly intialState: pulumi.Output<number>;
/**
* Magnet file extension.
*/
readonly magnetFileExtension: pulumi.Output<string>;
/**
* Music category.
*/
readonly musicCategory: pulumi.Output<string>;
/**
* Music directory.
*/
readonly musicDirectory: pulumi.Output<string>;
/**
* Music imported category.
*/
readonly musicImportedCategory: pulumi.Output<string>;
/**
* Download Client name.
*/
readonly name: pulumi.Output<string>;
/**
* NZB folder.
*/
readonly nzbFolder: pulumi.Output<string>;
/**
* Older Music priority. `0` Last, `1` First.
*/
readonly olderMusicPriority: pulumi.Output<number>;
/**
* Password.
*/
readonly password: pulumi.Output<string>;
/**
* Port.
*/
readonly port: pulumi.Output<number>;
/**
* Post import tags.
*/
readonly postImportTags: pulumi.Output<string[]>;
/**
* Priority.
*/
readonly priority: pulumi.Output<number>;
/**
* Protocol. Valid values are 'usenet' and 'torrent'.
*/
readonly protocol: pulumi.Output<string>;
/**
* Read only flag.
*/
readonly readOnly: pulumi.Output<boolean>;
/**
* Recent Music priority. `0` Last, `1` First.
*/
readonly recentMusicPriority: pulumi.Output<number>;
/**
* Remove completed downloads flag.
*/
readonly removeCompletedDownloads: pulumi.Output<boolean>;
/**
* Remove failed downloads flag.
*/
readonly removeFailedDownloads: pulumi.Output<boolean>;
/**
* RPC path.
*/
readonly rpcPath: pulumi.Output<string>;
/**
* Save magnet files flag.
*/
readonly saveMagnetFiles: pulumi.Output<boolean>;
/**
* Secret token.
*/
readonly secretToken: pulumi.Output<string>;
/**
* Sequential order flag.
*/
readonly sequentialOrder: pulumi.Output<boolean>;
/**
* Start on add flag.
*/
readonly startOnAdd: pulumi.Output<boolean>;
/**
* STRM folder.
*/
readonly strmFolder: pulumi.Output<string>;
/**
* List of associated tags.
*/
readonly tags: pulumi.Output<number[]>;
/**
* Torrent folder.
*/
readonly torrentFolder: pulumi.Output<string>;
/**
* Base URL.
*/
readonly urlBase: pulumi.Output<string>;
/**
* Use SSL flag.
*/
readonly useSsl: pulumi.Output<boolean>;
/**
* Username.
*/
readonly username: pulumi.Output<string>;
/**
* Watch folder flag.
*/
readonly watchFolder: pulumi.Output<string>;
/**
* Create a DownloadClient 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: DownloadClientArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DownloadClient resources.
*/
export interface DownloadClientState {
/**
* Add paused flag.
*/
addPaused?: pulumi.Input<boolean>;
/**
* Add stopped flag.
*/
addStopped?: pulumi.Input<boolean>;
/**
* Additional tags, `0` TitleSlug, `1` Quality, `2` Language, `3` ReleaseGroup, `4` Year, `5` Indexer, `6` Network.
*/
additionalTags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* API key.
*/
apiKey?: pulumi.Input<string>;
/**
* Category.
*/
category?: pulumi.Input<string>;
/**
* DownloadClient configuration template.
*/
configContract?: pulumi.Input<string>;
/**
* Destination.
*/
destination?: pulumi.Input<string>;
/**
* Enable flag.
*/
enable?: pulumi.Input<boolean>;
/**
* Field tags.
*/
fieldTags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* First and last flag.
*/
firstAndLast?: pulumi.Input<boolean>;
/**
* host.
*/
host?: pulumi.Input<string>;
/**
* DownloadClient implementation name.
*/
implementation?: pulumi.Input<string>;
/**
* Initial state. `0` Start, `1` ForceStart, `2` Pause.
*/
initialState?: pulumi.Input<number>;
/**
* Initial state, with Stop support. `0` Start, `1` ForceStart, `2` Pause, `3` Stop.
*/
intialState?: pulumi.Input<number>;
/**
* Magnet file extension.
*/
magnetFileExtension?: pulumi.Input<string>;
/**
* Music category.
*/
musicCategory?: pulumi.Input<string>;
/**
* Music directory.
*/
musicDirectory?: pulumi.Input<string>;
/**
* Music imported category.
*/
musicImportedCategory?: pulumi.Input<string>;
/**
* Download Client name.
*/
name?: pulumi.Input<string>;
/**
* NZB folder.
*/
nzbFolder?: pulumi.Input<string>;
/**
* Older Music priority. `0` Last, `1` First.
*/
olderMusicPriority?: pulumi.Input<number>;
/**
* Password.
*/
password?: pulumi.Input<string>;
/**
* Port.
*/
port?: pulumi.Input<number>;
/**
* Post import tags.
*/
postImportTags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Protocol. Valid values are 'usenet' and 'torrent'.
*/
protocol?: pulumi.Input<string>;
/**
* Read only flag.
*/
readOnly?: pulumi.Input<boolean>;
/**
* Recent Music priority. `0` Last, `1` First.
*/
recentMusicPriority?: pulumi.Input<number>;
/**
* Remove completed downloads flag.
*/
removeCompletedDownloads?: pulumi.Input<boolean>;
/**
* Remove failed downloads flag.
*/
removeFailedDownloads?: pulumi.Input<boolean>;
/**
* RPC path.
*/
rpcPath?: pulumi.Input<string>;
/**
* Save magnet files flag.
*/
saveMagnetFiles?: pulumi.Input<boolean>;
/**
* Secret token.
*/
secretToken?: pulumi.Input<string>;
/**
* Sequential order flag.
*/
sequentialOrder?: pulumi.Input<boolean>;
/**
* Start on add flag.
*/
startOnAdd?: pulumi.Input<boolean>;
/**
* STRM folder.
*/
strmFolder?: pulumi.Input<string>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Torrent folder.
*/
torrentFolder?: pulumi.Input<string>;
/**
* Base URL.
*/
urlBase?: pulumi.Input<string>;
/**
* Use SSL flag.
*/
useSsl?: pulumi.Input<boolean>;
/**
* Username.
*/
username?: pulumi.Input<string>;
/**
* Watch folder flag.
*/
watchFolder?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DownloadClient resource.
*/
export interface DownloadClientArgs {
/**
* Add paused flag.
*/
addPaused?: pulumi.Input<boolean>;
/**
* Add stopped flag.
*/
addStopped?: pulumi.Input<boolean>;
/**
* Additional tags, `0` TitleSlug, `1` Quality, `2` Language, `3` ReleaseGroup, `4` Year, `5` Indexer, `6` Network.
*/
additionalTags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* API key.
*/
apiKey?: pulumi.Input<string>;
/**
* Category.
*/
category?: pulumi.Input<string>;
/**
* DownloadClient configuration template.
*/
configContract: pulumi.Input<string>;
/**
* Destination.
*/
destination?: pulumi.Input<string>;
/**
* Enable flag.
*/
enable?: pulumi.Input<boolean>;
/**
* Field tags.
*/
fieldTags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* First and last flag.
*/
firstAndLast?: pulumi.Input<boolean>;
/**
* host.
*/
host?: pulumi.Input<string>;
/**
* DownloadClient implementation name.
*/
implementation: pulumi.Input<string>;
/**
* Initial state. `0` Start, `1` ForceStart, `2` Pause.
*/
initialState?: pulumi.Input<number>;
/**
* Initial state, with Stop support. `0` Start, `1` ForceStart, `2` Pause, `3` Stop.
*/
intialState?: pulumi.Input<number>;
/**
* Magnet file extension.
*/
magnetFileExtension?: pulumi.Input<string>;
/**
* Music category.
*/
musicCategory?: pulumi.Input<string>;
/**
* Music directory.
*/
musicDirectory?: pulumi.Input<string>;
/**
* Music imported category.
*/
musicImportedCategory?: pulumi.Input<string>;
/**
* Download Client name.
*/
name?: pulumi.Input<string>;
/**
* NZB folder.
*/
nzbFolder?: pulumi.Input<string>;
/**
* Older Music priority. `0` Last, `1` First.
*/
olderMusicPriority?: pulumi.Input<number>;
/**
* Password.
*/
password?: pulumi.Input<string>;
/**
* Port.
*/
port?: pulumi.Input<number>;
/**
* Post import tags.
*/
postImportTags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Protocol. Valid values are 'usenet' and 'torrent'.
*/
protocol: pulumi.Input<string>;
/**
* Read only flag.
*/
readOnly?: pulumi.Input<boolean>;
/**
* Recent Music priority. `0` Last, `1` First.
*/
recentMusicPriority?: pulumi.Input<number>;
/**
* Remove completed downloads flag.
*/
removeCompletedDownloads?: pulumi.Input<boolean>;
/**
* Remove failed downloads flag.
*/
removeFailedDownloads?: pulumi.Input<boolean>;
/**
* RPC path.
*/
rpcPath?: pulumi.Input<string>;
/**
* Save magnet files flag.
*/
saveMagnetFiles?: pulumi.Input<boolean>;
/**
* Secret token.
*/
secretToken?: pulumi.Input<string>;
/**
* Sequential order flag.
*/
sequentialOrder?: pulumi.Input<boolean>;
/**
* Start on add flag.
*/
startOnAdd?: pulumi.Input<boolean>;
/**
* STRM folder.
*/
strmFolder?: pulumi.Input<string>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Torrent folder.
*/
torrentFolder?: pulumi.Input<string>;
/**
* Base URL.
*/
urlBase?: pulumi.Input<string>;
/**
* Use SSL flag.
*/
useSsl?: pulumi.Input<boolean>;
/**
* Username.
*/
username?: pulumi.Input<string>;
/**
* Watch folder flag.
*/
watchFolder?: pulumi.Input<string>;
}