@maienm/pulumi-readarr
Version:
A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0
409 lines (408 loc) • 9.56 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Indexers -->Generic Indexer resource. When possible use a specific resource instead.
* For more information refer to [Indexer](https://wiki.servarr.com/readarr/settings#indexers) documentation.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as readarr from "@maienm/pulumi-readarr";
*
* const example = new readarr.indexers.Indexer("example", {
* apiPath: "/api",
* baseUrl: "https://lolo.sickbeard.com",
* categories: [
* 8000,
* 5000,
* ],
* configContract: "NewznabSettings",
* enableAutomaticSearch: true,
* implementation: "Newznab",
* protocol: "usenet",
* tags: [
* 1,
* 2,
* ],
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import readarr:Indexers/indexer:Indexer example 1
* ```
*/
export declare class Indexer extends pulumi.CustomResource {
/**
* Get an existing Indexer 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?: IndexerState, opts?: pulumi.CustomResourceOptions): Indexer;
/**
* Returns true if the given object is an instance of Indexer. 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 Indexer;
/**
* Additional parameters.
*/
readonly additionalParameters: pulumi.Output<string>;
/**
* Allow zero size files.
*/
readonly allowZeroSize: pulumi.Output<boolean>;
/**
* API key.
*/
readonly apiKey: pulumi.Output<string>;
/**
* API path.
*/
readonly apiPath: pulumi.Output<string>;
/**
* API User.
*/
readonly apiUser: pulumi.Output<string>;
/**
* Author seed time.
*/
readonly authorSeedTime: pulumi.Output<number>;
/**
* Base URL.
*/
readonly baseUrl: pulumi.Output<string>;
/**
* Captcha token.
*/
readonly captchaToken: pulumi.Output<string>;
/**
* Series list.
*/
readonly categories: pulumi.Output<number[]>;
/**
* Indexer configuration template.
*/
readonly configContract: pulumi.Output<string>;
/**
* Cookie.
*/
readonly cookie: pulumi.Output<string>;
/**
* Delay before grabbing.
*/
readonly delay: pulumi.Output<number>;
/**
* Early release limit.
*/
readonly earlyReleaseLimit: pulumi.Output<number>;
/**
* Enable automatic search flag.
*/
readonly enableAutomaticSearch: pulumi.Output<boolean>;
/**
* Enable interactive search flag.
*/
readonly enableInteractiveSearch: pulumi.Output<boolean>;
/**
* Enable RSS flag.
*/
readonly enableRss: pulumi.Output<boolean>;
/**
* Indexer implementation name.
*/
readonly implementation: pulumi.Output<string>;
/**
* Minimum seeders.
*/
readonly minimumSeeders: pulumi.Output<number>;
/**
* Indexer name.
*/
readonly name: pulumi.Output<string>;
/**
* Passkey.
*/
readonly passkey: pulumi.Output<string>;
/**
* Password.
*/
readonly password: pulumi.Output<string>;
/**
* Priority.
*/
readonly priority: pulumi.Output<number>;
/**
* Protocol. Valid values are 'usenet' and 'torrent'.
*/
readonly protocol: pulumi.Output<string>;
/**
* Allow ranked only.
*/
readonly rankedOnly: pulumi.Output<boolean>;
/**
* Seed ratio.
*/
readonly seedRatio: pulumi.Output<number>;
/**
* Seed time.
*/
readonly seedTime: pulumi.Output<number>;
/**
* List of associated tags.
*/
readonly tags: pulumi.Output<number[]>;
/**
* Username.
*/
readonly username: pulumi.Output<string>;
/**
* Create a Indexer 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: IndexerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Indexer resources.
*/
export interface IndexerState {
/**
* Additional parameters.
*/
additionalParameters?: pulumi.Input<string>;
/**
* Allow zero size files.
*/
allowZeroSize?: pulumi.Input<boolean>;
/**
* API key.
*/
apiKey?: pulumi.Input<string>;
/**
* API path.
*/
apiPath?: pulumi.Input<string>;
/**
* API User.
*/
apiUser?: pulumi.Input<string>;
/**
* Author seed time.
*/
authorSeedTime?: pulumi.Input<number>;
/**
* Base URL.
*/
baseUrl?: pulumi.Input<string>;
/**
* Captcha token.
*/
captchaToken?: pulumi.Input<string>;
/**
* Series list.
*/
categories?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Indexer configuration template.
*/
configContract?: pulumi.Input<string>;
/**
* Cookie.
*/
cookie?: pulumi.Input<string>;
/**
* Delay before grabbing.
*/
delay?: pulumi.Input<number>;
/**
* Early release limit.
*/
earlyReleaseLimit?: pulumi.Input<number>;
/**
* Enable automatic search flag.
*/
enableAutomaticSearch?: pulumi.Input<boolean>;
/**
* Enable interactive search flag.
*/
enableInteractiveSearch?: pulumi.Input<boolean>;
/**
* Enable RSS flag.
*/
enableRss?: pulumi.Input<boolean>;
/**
* Indexer implementation name.
*/
implementation?: pulumi.Input<string>;
/**
* Minimum seeders.
*/
minimumSeeders?: pulumi.Input<number>;
/**
* Indexer name.
*/
name?: pulumi.Input<string>;
/**
* Passkey.
*/
passkey?: pulumi.Input<string>;
/**
* Password.
*/
password?: pulumi.Input<string>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Protocol. Valid values are 'usenet' and 'torrent'.
*/
protocol?: pulumi.Input<string>;
/**
* Allow ranked only.
*/
rankedOnly?: pulumi.Input<boolean>;
/**
* Seed ratio.
*/
seedRatio?: pulumi.Input<number>;
/**
* Seed time.
*/
seedTime?: pulumi.Input<number>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Username.
*/
username?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Indexer resource.
*/
export interface IndexerArgs {
/**
* Additional parameters.
*/
additionalParameters?: pulumi.Input<string>;
/**
* Allow zero size files.
*/
allowZeroSize?: pulumi.Input<boolean>;
/**
* API key.
*/
apiKey?: pulumi.Input<string>;
/**
* API path.
*/
apiPath?: pulumi.Input<string>;
/**
* API User.
*/
apiUser?: pulumi.Input<string>;
/**
* Author seed time.
*/
authorSeedTime?: pulumi.Input<number>;
/**
* Base URL.
*/
baseUrl?: pulumi.Input<string>;
/**
* Captcha token.
*/
captchaToken?: pulumi.Input<string>;
/**
* Series list.
*/
categories?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Indexer configuration template.
*/
configContract: pulumi.Input<string>;
/**
* Cookie.
*/
cookie?: pulumi.Input<string>;
/**
* Delay before grabbing.
*/
delay?: pulumi.Input<number>;
/**
* Early release limit.
*/
earlyReleaseLimit?: pulumi.Input<number>;
/**
* Enable automatic search flag.
*/
enableAutomaticSearch?: pulumi.Input<boolean>;
/**
* Enable interactive search flag.
*/
enableInteractiveSearch?: pulumi.Input<boolean>;
/**
* Enable RSS flag.
*/
enableRss?: pulumi.Input<boolean>;
/**
* Indexer implementation name.
*/
implementation: pulumi.Input<string>;
/**
* Minimum seeders.
*/
minimumSeeders?: pulumi.Input<number>;
/**
* Indexer name.
*/
name?: pulumi.Input<string>;
/**
* Passkey.
*/
passkey?: pulumi.Input<string>;
/**
* Password.
*/
password?: pulumi.Input<string>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Protocol. Valid values are 'usenet' and 'torrent'.
*/
protocol: pulumi.Input<string>;
/**
* Allow ranked only.
*/
rankedOnly?: pulumi.Input<boolean>;
/**
* Seed ratio.
*/
seedRatio?: pulumi.Input<number>;
/**
* Seed time.
*/
seedTime?: pulumi.Input<number>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Username.
*/
username?: pulumi.Input<string>;
}