UNPKG

@maienm/pulumi-readarr

Version:

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

276 lines (275 loc) 7.2 kB
import * as pulumi from "@pulumi/pulumi"; /** * <!-- subcategory:Notifications -->Notification Telegram resource. * For more information refer to [Notification](https://wiki.servarr.com/readarr/settings#connect) and [Telegram](https://wiki.servarr.com/readarr/supported#telegram). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as readarr from "@maienm/pulumi-readarr"; * * const example = new readarr.notifications.Telegram("example", { * botToken: "Token", * chatId: "ChatID01", * includeHealthWarnings: false, * onAuthorDelete: false, * onBookDelete: false, * onBookFileDelete: true, * onBookFileDeleteForUpgrade: false, * onDownloadFailure: false, * onGrab: false, * onHealthIssue: false, * onImportFailure: true, * onReleaseImport: false, * onUpgrade: false, * }); * ``` * * ## Import * * import using the API/UI ID * * ```sh * $ pulumi import readarr:Notifications/telegram:Telegram example 1 * ``` */ export declare class Telegram extends pulumi.CustomResource { /** * Get an existing Telegram 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?: TelegramState, opts?: pulumi.CustomResourceOptions): Telegram; /** * Returns true if the given object is an instance of Telegram. 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 Telegram; /** * Bot token. */ readonly botToken: pulumi.Output<string>; /** * Chat ID. */ readonly chatId: pulumi.Output<string>; /** * Include health warnings. */ readonly includeHealthWarnings: pulumi.Output<boolean>; /** * Notification name. */ readonly name: pulumi.Output<string>; /** * On application update flag. */ readonly onApplicationUpdate: pulumi.Output<boolean>; /** * On author deleted flag. */ readonly onAuthorDelete: 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 download failure flag. */ readonly onDownloadFailure: pulumi.Output<boolean>; /** * On grab flag. */ readonly onGrab: pulumi.Output<boolean>; /** * On health issue flag. */ readonly onHealthIssue: pulumi.Output<boolean>; /** * On import failure flag. */ readonly onImportFailure: pulumi.Output<boolean>; /** * On release import flag. */ readonly onReleaseImport: pulumi.Output<boolean>; /** * On upgrade flag. */ readonly onUpgrade: pulumi.Output<boolean>; /** * Send silently flag. */ readonly sendSilently: pulumi.Output<boolean>; /** * List of associated tags. */ readonly tags: pulumi.Output<number[]>; /** * Create a Telegram 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: TelegramArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Telegram resources. */ export interface TelegramState { /** * Bot token. */ botToken?: pulumi.Input<string>; /** * Chat ID. */ chatId?: pulumi.Input<string>; /** * Include health warnings. */ includeHealthWarnings?: pulumi.Input<boolean>; /** * Notification name. */ name?: pulumi.Input<string>; /** * On application update flag. */ onApplicationUpdate?: pulumi.Input<boolean>; /** * On author deleted flag. */ onAuthorDelete?: 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 download failure flag. */ onDownloadFailure?: pulumi.Input<boolean>; /** * On grab flag. */ onGrab?: pulumi.Input<boolean>; /** * On health issue flag. */ onHealthIssue?: pulumi.Input<boolean>; /** * On import failure flag. */ onImportFailure?: pulumi.Input<boolean>; /** * On release import flag. */ onReleaseImport?: pulumi.Input<boolean>; /** * On upgrade flag. */ onUpgrade?: pulumi.Input<boolean>; /** * Send silently flag. */ sendSilently?: pulumi.Input<boolean>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; } /** * The set of arguments for constructing a Telegram resource. */ export interface TelegramArgs { /** * Bot token. */ botToken: pulumi.Input<string>; /** * Chat ID. */ chatId: pulumi.Input<string>; /** * Include health warnings. */ includeHealthWarnings?: pulumi.Input<boolean>; /** * Notification name. */ name?: pulumi.Input<string>; /** * On application update flag. */ onApplicationUpdate?: pulumi.Input<boolean>; /** * On author deleted flag. */ onAuthorDelete?: 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 download failure flag. */ onDownloadFailure?: pulumi.Input<boolean>; /** * On grab flag. */ onGrab?: pulumi.Input<boolean>; /** * On health issue flag. */ onHealthIssue?: pulumi.Input<boolean>; /** * On import failure flag. */ onImportFailure?: pulumi.Input<boolean>; /** * On release import flag. */ onReleaseImport?: pulumi.Input<boolean>; /** * On upgrade flag. */ onUpgrade?: pulumi.Input<boolean>; /** * Send silently flag. */ sendSilently?: pulumi.Input<boolean>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; }