UNPKG

@maienm/pulumi-prowlarr

Version:

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

56 lines (55 loc) 2.84 kB
import * as pulumi from "@pulumi/pulumi"; /** * The provider type for the prowlarr package. By default, resources use package-wide configuration * settings, however an explicit `Provider` instance may be created and passed during resource * construction to achieve fine-grained programmatic control over provider settings. See the * [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information. */ export declare class Provider extends pulumi.ProviderResource { /** * Returns true if the given object is an instance of Provider. 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 Provider; /** * API key for Prowlarr authentication. Can be specified via the `PROWLARR_API_KEY` environment variable. */ readonly apiKey: pulumi.Output<string | undefined>; /** * Token for token-based authentication with Prowlarr. This is an alternative to using an API key. Set this via the * `PROWLARR_AUTHORIZATION` environment variable. One of `authorization` or `api_key` must be provided, but not both. */ readonly authorization: pulumi.Output<string | undefined>; /** * Full Prowlarr URL with protocol and port (e.g. `https://test.prowlarr.com:9696`). You should **NOT** supply any path * (`/api`), the SDK will use the appropriate paths. Can be specified via the `PROWLARR_URL` environment variable. */ readonly url: pulumi.Output<string | undefined>; /** * Create a Provider 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?: ProviderArgs, opts?: pulumi.ResourceOptions); } /** * The set of arguments for constructing a Provider resource. */ export interface ProviderArgs { /** * API key for Prowlarr authentication. Can be specified via the `PROWLARR_API_KEY` environment variable. */ apiKey?: pulumi.Input<string>; /** * Token for token-based authentication with Prowlarr. This is an alternative to using an API key. Set this via the * `PROWLARR_AUTHORIZATION` environment variable. One of `authorization` or `api_key` must be provided, but not both. */ authorization?: pulumi.Input<string>; /** * Full Prowlarr URL with protocol and port (e.g. `https://test.prowlarr.com:9696`). You should **NOT** supply any path * (`/api`), the SDK will use the appropriate paths. Can be specified via the `PROWLARR_URL` environment variable. */ url?: pulumi.Input<string>; }