@maienm/pulumi-readarr
Version:
A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0
269 lines (268 loc) • 6.93 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Download Clients -->Download Client uTorrent resource.
* For more information refer to [Download Client](https://wiki.servarr.com/readarr/settings#download-clients) and [uTorrent](https://wiki.servarr.com/readarr/supported#utorrent).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as readarr from "@maienm/pulumi-readarr";
*
* const example = new readarr.downloadclients.Utorrent("example", {
* bookCategory: "tv-readarr",
* enable: true,
* host: "utorrent",
* port: 9091,
* priority: 1,
* urlBase: "/utorrent/",
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import readarr:DownloadClients/utorrent:Utorrent example 1
* ```
*/
export declare class Utorrent extends pulumi.CustomResource {
/**
* Get an existing Utorrent 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?: UtorrentState, opts?: pulumi.CustomResourceOptions): Utorrent;
/**
* Returns true if the given object is an instance of Utorrent. 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 Utorrent;
/**
* Book category.
*/
readonly bookCategory: pulumi.Output<string>;
/**
* Book imported category.
*/
readonly bookImportedCategory: pulumi.Output<string>;
/**
* Enable flag.
*/
readonly enable: pulumi.Output<boolean>;
/**
* host.
*/
readonly host: pulumi.Output<string>;
/**
* Initial state, with Stop support. `0` Start, `1` ForceStart, `2` Pause, `3` Stop.
*/
readonly intialState: pulumi.Output<number>;
/**
* Download Client name.
*/
readonly name: pulumi.Output<string>;
/**
* Older Music priority. `0` Last, `1` First.
*/
readonly olderBookPriority: pulumi.Output<number>;
/**
* Password.
*/
readonly password: pulumi.Output<string>;
/**
* Port.
*/
readonly port: pulumi.Output<number>;
/**
* Priority.
*/
readonly priority: pulumi.Output<number>;
/**
* Recent Music priority. `0` Last, `1` First.
*/
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>;
/**
* Use SSL flag.
*/
readonly useSsl: pulumi.Output<boolean>;
/**
* Username.
*/
readonly username: pulumi.Output<string>;
/**
* Create a Utorrent 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?: UtorrentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Utorrent resources.
*/
export interface UtorrentState {
/**
* Book category.
*/
bookCategory?: pulumi.Input<string>;
/**
* Book imported category.
*/
bookImportedCategory?: pulumi.Input<string>;
/**
* Enable flag.
*/
enable?: pulumi.Input<boolean>;
/**
* host.
*/
host?: pulumi.Input<string>;
/**
* Initial state, with Stop support. `0` Start, `1` ForceStart, `2` Pause, `3` Stop.
*/
intialState?: pulumi.Input<number>;
/**
* Download Client name.
*/
name?: pulumi.Input<string>;
/**
* Older Music priority. `0` Last, `1` First.
*/
olderBookPriority?: pulumi.Input<number>;
/**
* Password.
*/
password?: pulumi.Input<string>;
/**
* Port.
*/
port?: pulumi.Input<number>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Recent Music priority. `0` Last, `1` First.
*/
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>;
/**
* Use SSL flag.
*/
useSsl?: pulumi.Input<boolean>;
/**
* Username.
*/
username?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Utorrent resource.
*/
export interface UtorrentArgs {
/**
* Book category.
*/
bookCategory?: pulumi.Input<string>;
/**
* Book imported category.
*/
bookImportedCategory?: pulumi.Input<string>;
/**
* Enable flag.
*/
enable?: pulumi.Input<boolean>;
/**
* host.
*/
host?: pulumi.Input<string>;
/**
* Initial state, with Stop support. `0` Start, `1` ForceStart, `2` Pause, `3` Stop.
*/
intialState?: pulumi.Input<number>;
/**
* Download Client name.
*/
name?: pulumi.Input<string>;
/**
* Older Music priority. `0` Last, `1` First.
*/
olderBookPriority?: pulumi.Input<number>;
/**
* Password.
*/
password?: pulumi.Input<string>;
/**
* Port.
*/
port?: pulumi.Input<number>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Recent Music priority. `0` Last, `1` First.
*/
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>;
/**
* Use SSL flag.
*/
useSsl?: pulumi.Input<boolean>;
/**
* Username.
*/
username?: pulumi.Input<string>;
}