@maienm/pulumi-readarr
Version:
A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0
46 lines (45 loc) • 2.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The provider type for the readarr 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 Readarr authentication. Can be specified via the `READARR_API_KEY` environment variable.
*/
readonly apiKey: pulumi.Output<string | undefined>;
/**
* Full Readarr URL with protocol and port (e.g. `https://test.readarr.lib:8787`). You should **NOT** supply any path
* (`/api`), the SDK will use the appropriate paths. Can be specified via the `READARR_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 Readarr authentication. Can be specified via the `READARR_API_KEY` environment variable.
*/
apiKey?: pulumi.Input<string>;
/**
* Full Readarr URL with protocol and port (e.g. `https://test.readarr.lib:8787`). You should **NOT** supply any path
* (`/api`), the SDK will use the appropriate paths. Can be specified via the `READARR_URL` environment variable.
*/
url?: pulumi.Input<string>;
}