@maienm/pulumi-readarr
Version:
A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0
280 lines (279 loc) • 7.09 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Download Clients -->Download Client RTorrent resource.
* For more information refer to [Download Client](https://wiki.servarr.com/readarr/settings#download-clients) and [RTorrent](https://wiki.servarr.com/readarr/supported#rtorrent).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as readarr from "@maienm/pulumi-readarr";
*
* const example = new readarr.downloadclients.Rtorrent("example", {
* enable: true,
* host: "rtorrent",
* port: 9091,
* priority: 1,
* urlBase: "/rtorrent/",
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import readarr:DownloadClients/rtorrent:Rtorrent example 1
* ```
*/
export declare class Rtorrent extends pulumi.CustomResource {
/**
* Get an existing Rtorrent 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?: RtorrentState, opts?: pulumi.CustomResourceOptions): Rtorrent;
/**
* Returns true if the given object is an instance of Rtorrent. 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 Rtorrent;
/**
* Add stopped flag.
*/
readonly addStopped: pulumi.Output<boolean>;
/**
* Book category.
*/
readonly bookCategory: pulumi.Output<string>;
/**
* Book directory.
*/
readonly bookDirectory: pulumi.Output<string>;
/**
* Book imported category.
*/
readonly bookImportedCategory: pulumi.Output<string>;
/**
* Enable flag.
*/
readonly enable: pulumi.Output<boolean>;
/**
* host.
*/
readonly host: pulumi.Output<string>;
/**
* Download Client name.
*/
readonly name: pulumi.Output<string>;
/**
* Older Music priority. `0` VeryLow, `1` Low, `2` Normal, `3` High.
*/
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` VeryLow, `1` Low, `2` Normal, `3` High.
*/
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 Rtorrent 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?: RtorrentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Rtorrent resources.
*/
export interface RtorrentState {
/**
* Add stopped flag.
*/
addStopped?: pulumi.Input<boolean>;
/**
* Book category.
*/
bookCategory?: pulumi.Input<string>;
/**
* Book directory.
*/
bookDirectory?: pulumi.Input<string>;
/**
* Book imported category.
*/
bookImportedCategory?: pulumi.Input<string>;
/**
* Enable flag.
*/
enable?: pulumi.Input<boolean>;
/**
* host.
*/
host?: pulumi.Input<string>;
/**
* Download Client name.
*/
name?: pulumi.Input<string>;
/**
* Older Music priority. `0` VeryLow, `1` Low, `2` Normal, `3` High.
*/
olderBookPriority?: pulumi.Input<number>;
/**
* Password.
*/
password?: pulumi.Input<string>;
/**
* Port.
*/
port?: pulumi.Input<number>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Recent Music priority. `0` VeryLow, `1` Low, `2` Normal, `3` High.
*/
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 Rtorrent resource.
*/
export interface RtorrentArgs {
/**
* Add stopped flag.
*/
addStopped?: pulumi.Input<boolean>;
/**
* Book category.
*/
bookCategory?: pulumi.Input<string>;
/**
* Book directory.
*/
bookDirectory?: pulumi.Input<string>;
/**
* Book imported category.
*/
bookImportedCategory?: pulumi.Input<string>;
/**
* Enable flag.
*/
enable?: pulumi.Input<boolean>;
/**
* host.
*/
host?: pulumi.Input<string>;
/**
* Download Client name.
*/
name?: pulumi.Input<string>;
/**
* Older Music priority. `0` VeryLow, `1` Low, `2` Normal, `3` High.
*/
olderBookPriority?: pulumi.Input<number>;
/**
* Password.
*/
password?: pulumi.Input<string>;
/**
* Port.
*/
port?: pulumi.Input<number>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Recent Music priority. `0` VeryLow, `1` Low, `2` Normal, `3` High.
*/
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>;
}