@maienm/pulumi-readarr
Version:
A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0
214 lines (213 loc) • 5.48 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Indexers -->Indexer Newznab resource.
* For more information refer to [Indexer](https://wiki.servarr.com/readarr/settings#indexers) and [Newznab](https://wiki.servarr.com/readarr/supported#newznab).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as readarr from "@maienm/pulumi-readarr";
*
* const example = new readarr.indexers.Newznab("example", {
* apiPath: "/api",
* baseUrl: "https://lolo.sickbeard.com",
* categories: [
* 8000,
* 5000,
* ],
* enableAutomaticSearch: true,
* tags: [
* 1,
* 2,
* ],
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import readarr:Indexers/newznab:Newznab example 1
* ```
*/
export declare class Newznab extends pulumi.CustomResource {
/**
* Get an existing Newznab 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?: NewznabState, opts?: pulumi.CustomResourceOptions): Newznab;
/**
* Returns true if the given object is an instance of Newznab. 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 Newznab;
/**
* Additional parameters.
*/
readonly additionalParameters: pulumi.Output<string>;
/**
* API key.
*/
readonly apiKey: pulumi.Output<string>;
/**
* API path.
*/
readonly apiPath: pulumi.Output<string>;
/**
* Base URL.
*/
readonly baseUrl: pulumi.Output<string>;
/**
* Series list.
*/
readonly categories: 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>;
/**
* IndexerNewznab name.
*/
readonly name: pulumi.Output<string>;
/**
* Priority.
*/
readonly priority: pulumi.Output<number>;
/**
* List of associated tags.
*/
readonly tags: pulumi.Output<number[]>;
/**
* Create a Newznab 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?: NewznabArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Newznab resources.
*/
export interface NewznabState {
/**
* Additional parameters.
*/
additionalParameters?: pulumi.Input<string>;
/**
* API key.
*/
apiKey?: pulumi.Input<string>;
/**
* API path.
*/
apiPath?: pulumi.Input<string>;
/**
* Base URL.
*/
baseUrl?: pulumi.Input<string>;
/**
* Series list.
*/
categories?: pulumi.Input<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>;
/**
* IndexerNewznab name.
*/
name?: pulumi.Input<string>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
}
/**
* The set of arguments for constructing a Newznab resource.
*/
export interface NewznabArgs {
/**
* Additional parameters.
*/
additionalParameters?: pulumi.Input<string>;
/**
* API key.
*/
apiKey?: pulumi.Input<string>;
/**
* API path.
*/
apiPath?: pulumi.Input<string>;
/**
* Base URL.
*/
baseUrl?: pulumi.Input<string>;
/**
* Series list.
*/
categories?: pulumi.Input<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>;
/**
* IndexerNewznab name.
*/
name?: pulumi.Input<string>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
}