UNPKG

@maienm/pulumi-readarr

Version:

A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0

225 lines (224 loc) 5.7 kB
import * as pulumi from "@pulumi/pulumi"; /** * <!-- subcategory:Notifications -->Notification Kavita resource. * For more information refer to [Notification](https://wiki.servarr.com/readarr/settings#connect) and [Kavita](https://wiki.servarr.com/readarr/supported#kavita). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as readarr from "@maienm/pulumi-readarr"; * * const example = new readarr.notifications.Kavita("example", { * apiKey: "APIKey", * host: "kavita.local", * notify: true, * onBookDelete: false, * onBookFileDelete: false, * onBookFileDeleteForUpgrade: false, * onBookRetag: false, * onReleaseImport: false, * onUpgrade: false, * port: 4040, * }); * ``` * * ## Import * * import using the API/UI ID * * ```sh * $ pulumi import readarr:Notifications/kavita:Kavita example 1 * ``` */ export declare class Kavita extends pulumi.CustomResource { /** * Get an existing Kavita 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?: KavitaState, opts?: pulumi.CustomResourceOptions): Kavita; /** * Returns true if the given object is an instance of Kavita. 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 Kavita; /** * API key. */ readonly apiKey: pulumi.Output<string>; /** * Host. */ readonly host: pulumi.Output<string>; /** * Notification name. */ readonly name: pulumi.Output<string>; /** * Update library. */ readonly notify: pulumi.Output<boolean>; /** * On book delete flag. */ readonly onBookDelete: pulumi.Output<boolean>; /** * On book file delete flag. */ readonly onBookFileDelete: pulumi.Output<boolean>; /** * On book file delete for upgrade flag. */ readonly onBookFileDeleteForUpgrade: pulumi.Output<boolean>; /** * On book retag flag. */ readonly onBookRetag: pulumi.Output<boolean>; /** * On release import flag. */ readonly onReleaseImport: pulumi.Output<boolean>; /** * On upgrade flag. */ readonly onUpgrade: pulumi.Output<boolean>; /** * Port. */ readonly port: pulumi.Output<number>; /** * List of associated tags. */ readonly tags: pulumi.Output<number[]>; /** * Use SSL flag. */ readonly useSsl: pulumi.Output<boolean>; /** * Create a Kavita 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: KavitaArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Kavita resources. */ export interface KavitaState { /** * API key. */ apiKey?: pulumi.Input<string>; /** * Host. */ host?: pulumi.Input<string>; /** * Notification name. */ name?: pulumi.Input<string>; /** * Update library. */ notify?: pulumi.Input<boolean>; /** * On book delete flag. */ onBookDelete?: pulumi.Input<boolean>; /** * On book file delete flag. */ onBookFileDelete?: pulumi.Input<boolean>; /** * On book file delete for upgrade flag. */ onBookFileDeleteForUpgrade?: pulumi.Input<boolean>; /** * On book retag flag. */ onBookRetag?: pulumi.Input<boolean>; /** * On release import flag. */ onReleaseImport?: pulumi.Input<boolean>; /** * On upgrade flag. */ onUpgrade?: pulumi.Input<boolean>; /** * Port. */ port?: pulumi.Input<number>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; /** * Use SSL flag. */ useSsl?: pulumi.Input<boolean>; } /** * The set of arguments for constructing a Kavita resource. */ export interface KavitaArgs { /** * API key. */ apiKey: pulumi.Input<string>; /** * Host. */ host: pulumi.Input<string>; /** * Notification name. */ name?: pulumi.Input<string>; /** * Update library. */ notify: pulumi.Input<boolean>; /** * On book delete flag. */ onBookDelete?: pulumi.Input<boolean>; /** * On book file delete flag. */ onBookFileDelete?: pulumi.Input<boolean>; /** * On book file delete for upgrade flag. */ onBookFileDeleteForUpgrade?: pulumi.Input<boolean>; /** * On book retag flag. */ onBookRetag?: pulumi.Input<boolean>; /** * On release import flag. */ onReleaseImport?: pulumi.Input<boolean>; /** * On upgrade flag. */ onUpgrade?: pulumi.Input<boolean>; /** * Port. */ port: pulumi.Input<number>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; /** * Use SSL flag. */ useSsl?: pulumi.Input<boolean>; }