UNPKG

@maienm/pulumi-prowlarr

Version:

A Pulumi package for creating and managing Prowlarr resources. Based on terraform-provider-prowlarr: version v2.3.0

165 lines (164 loc) 4.42 kB
import * as pulumi from "@pulumi/pulumi"; /** * <!-- subcategory:Applications -->Application Sonarr resource. * For more information refer to [Application](https://wiki.servarr.com/prowlarr/settings#applications) and [Sonarr](https://wiki.servarr.com/prowlarr/supported#sonarr). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as prowlarr from "@maienm/pulumi-prowlarr"; * * const example = new prowlarr.applications.Sonarr("example", { * animeSyncCategories: [5070], * apiKey: "APIKey", * baseUrl: "http://localhost:8989", * prowlarrUrl: "http://localhost:9696", * syncCategories: [ * 5000, * 5010, * 5030, * ], * syncLevel: "addOnly", * }); * ``` * * ## Import * * import using the API/UI ID * * ```sh * $ pulumi import prowlarr:Applications/sonarr:Sonarr example 1 * ``` */ export declare class Sonarr extends pulumi.CustomResource { /** * Get an existing Sonarr 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?: SonarrState, opts?: pulumi.CustomResourceOptions): Sonarr; /** * Returns true if the given object is an instance of Sonarr. 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 Sonarr; /** * Anime sync categories. */ readonly animeSyncCategories: pulumi.Output<number[]>; /** * API key. */ readonly apiKey: pulumi.Output<string>; /** * Base URL. */ readonly baseUrl: pulumi.Output<string>; /** * Application name. */ readonly name: pulumi.Output<string>; /** * Prowlarr URL. */ readonly prowlarrUrl: pulumi.Output<string>; /** * Sync categories. */ readonly syncCategories: pulumi.Output<number[]>; /** * Sync level. */ readonly syncLevel: pulumi.Output<string>; /** * List of associated tags. */ readonly tags: pulumi.Output<number[]>; /** * Create a Sonarr 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: SonarrArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Sonarr resources. */ export interface SonarrState { /** * Anime sync categories. */ animeSyncCategories?: pulumi.Input<pulumi.Input<number>[]>; /** * API key. */ apiKey?: pulumi.Input<string>; /** * Base URL. */ baseUrl?: pulumi.Input<string>; /** * Application name. */ name?: pulumi.Input<string>; /** * Prowlarr URL. */ prowlarrUrl?: pulumi.Input<string>; /** * Sync categories. */ syncCategories?: pulumi.Input<pulumi.Input<number>[]>; /** * Sync level. */ syncLevel?: pulumi.Input<string>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; } /** * The set of arguments for constructing a Sonarr resource. */ export interface SonarrArgs { /** * Anime sync categories. */ animeSyncCategories?: pulumi.Input<pulumi.Input<number>[]>; /** * API key. */ apiKey: pulumi.Input<string>; /** * Base URL. */ baseUrl: pulumi.Input<string>; /** * Application name. */ name?: pulumi.Input<string>; /** * Prowlarr URL. */ prowlarrUrl: pulumi.Input<string>; /** * Sync categories. */ syncCategories?: pulumi.Input<pulumi.Input<number>[]>; /** * Sync level. */ syncLevel: pulumi.Input<string>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; }