UNPKG

@maienm/pulumi-prowlarr

Version:

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

208 lines (207 loc) 5.66 kB
import * as pulumi from "@pulumi/pulumi"; /** * <!-- subcategory:Notifications -->Notification Pushbullet resource. * For more information refer to [Notification](https://wiki.servarr.com/prowlarr/settings#connect) and [Pushbullet](https://wiki.servarr.com/prowlarr/supported#pushbullet). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as prowlarr from "@maienm/pulumi-prowlarr"; * * const example = new prowlarr.notifications.Pushbullet("example", { * apiKey: "Token", * deviceIds: ["test"], * includeHealthWarnings: false, * onApplicationUpdate: false, * onHealthIssue: false, * }); * ``` * * ## Import * * import using the API/UI ID * * ```sh * $ pulumi import prowlarr:Notifications/pushbullet:Pushbullet example 1 * ``` */ export declare class Pushbullet extends pulumi.CustomResource { /** * Get an existing Pushbullet 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?: PushbulletState, opts?: pulumi.CustomResourceOptions): Pushbullet; /** * Returns true if the given object is an instance of Pushbullet. 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 Pushbullet; /** * API key. */ readonly apiKey: pulumi.Output<string>; /** * List of channel tags. */ readonly channelTags: pulumi.Output<string[]>; /** * List of devices IDs. */ readonly deviceIds: pulumi.Output<string[]>; /** * Include health warnings. */ readonly includeHealthWarnings: pulumi.Output<boolean>; /** * Include manual grab flag. */ readonly includeManualGrabs: pulumi.Output<boolean>; /** * NotificationPushbullet name. */ readonly name: pulumi.Output<string>; /** * On application update flag. */ readonly onApplicationUpdate: pulumi.Output<boolean>; /** * On release grab flag. */ readonly onGrab: pulumi.Output<boolean>; /** * On health issue flag. */ readonly onHealthIssue: pulumi.Output<boolean>; /** * On health restored flag. */ readonly onHealthRestored: pulumi.Output<boolean>; /** * Sender ID. */ readonly senderId: pulumi.Output<string>; /** * List of associated tags. */ readonly tags: pulumi.Output<number[]>; /** * Create a Pushbullet 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: PushbulletArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Pushbullet resources. */ export interface PushbulletState { /** * API key. */ apiKey?: pulumi.Input<string>; /** * List of channel tags. */ channelTags?: pulumi.Input<pulumi.Input<string>[]>; /** * List of devices IDs. */ deviceIds?: pulumi.Input<pulumi.Input<string>[]>; /** * Include health warnings. */ includeHealthWarnings?: pulumi.Input<boolean>; /** * Include manual grab flag. */ includeManualGrabs?: pulumi.Input<boolean>; /** * NotificationPushbullet name. */ name?: pulumi.Input<string>; /** * On application update flag. */ onApplicationUpdate?: pulumi.Input<boolean>; /** * On release grab flag. */ onGrab?: pulumi.Input<boolean>; /** * On health issue flag. */ onHealthIssue?: pulumi.Input<boolean>; /** * On health restored flag. */ onHealthRestored?: pulumi.Input<boolean>; /** * Sender ID. */ senderId?: pulumi.Input<string>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; } /** * The set of arguments for constructing a Pushbullet resource. */ export interface PushbulletArgs { /** * API key. */ apiKey: pulumi.Input<string>; /** * List of channel tags. */ channelTags?: pulumi.Input<pulumi.Input<string>[]>; /** * List of devices IDs. */ deviceIds?: pulumi.Input<pulumi.Input<string>[]>; /** * Include health warnings. */ includeHealthWarnings?: pulumi.Input<boolean>; /** * Include manual grab flag. */ includeManualGrabs?: pulumi.Input<boolean>; /** * NotificationPushbullet name. */ name?: pulumi.Input<string>; /** * On application update flag. */ onApplicationUpdate?: pulumi.Input<boolean>; /** * On release grab flag. */ onGrab?: pulumi.Input<boolean>; /** * On health issue flag. */ onHealthIssue?: pulumi.Input<boolean>; /** * On health restored flag. */ onHealthRestored?: pulumi.Input<boolean>; /** * Sender ID. */ senderId?: pulumi.Input<string>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; }