UNPKG

@maienm/pulumi-prowlarr

Version:

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

185 lines (184 loc) 4.87 kB
import * as pulumi from "@pulumi/pulumi"; /** * <!-- subcategory:Notifications -->Notification Slack resource. * For more information refer to [Notification](https://wiki.servarr.com/prowlarr/settings#connect) and [Slack](https://wiki.servarr.com/prowlarr/supported#slack). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as prowlarr from "@maienm/pulumi-prowlarr"; * * const example = new prowlarr.notifications.Slack("example", { * channel: "example-channel", * includeHealthWarnings: false, * onApplicationUpdate: false, * onHealthIssue: false, * username: "user", * webHookUrl: "http://my.slack.com/test", * }); * ``` * * ## Import * * import using the API/UI ID * * ```sh * $ pulumi import prowlarr:Notifications/slack:Slack example 1 * ``` */ export declare class Slack extends pulumi.CustomResource { /** * Get an existing Slack 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?: SlackState, opts?: pulumi.CustomResourceOptions): Slack; /** * Returns true if the given object is an instance of Slack. 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 Slack; /** * Channel. */ readonly channel: pulumi.Output<string>; /** * Icon. */ readonly icon: pulumi.Output<string>; /** * Include health warnings. */ readonly includeHealthWarnings: pulumi.Output<boolean>; /** * NotificationSlack name. */ readonly name: pulumi.Output<string>; /** * On application update flag. */ readonly onApplicationUpdate: pulumi.Output<boolean>; /** * On health issue flag. */ readonly onHealthIssue: pulumi.Output<boolean>; /** * On health restored flag. */ readonly onHealthRestored: pulumi.Output<boolean>; /** * List of associated tags. */ readonly tags: pulumi.Output<number[]>; /** * Username. */ readonly username: pulumi.Output<string>; /** * URL. */ readonly webHookUrl: pulumi.Output<string>; /** * Create a Slack 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: SlackArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Slack resources. */ export interface SlackState { /** * Channel. */ channel?: pulumi.Input<string>; /** * Icon. */ icon?: pulumi.Input<string>; /** * Include health warnings. */ includeHealthWarnings?: pulumi.Input<boolean>; /** * NotificationSlack name. */ name?: pulumi.Input<string>; /** * On application update flag. */ onApplicationUpdate?: pulumi.Input<boolean>; /** * On health issue flag. */ onHealthIssue?: pulumi.Input<boolean>; /** * On health restored flag. */ onHealthRestored?: pulumi.Input<boolean>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; /** * Username. */ username?: pulumi.Input<string>; /** * URL. */ webHookUrl?: pulumi.Input<string>; } /** * The set of arguments for constructing a Slack resource. */ export interface SlackArgs { /** * Channel. */ channel?: pulumi.Input<string>; /** * Icon. */ icon?: pulumi.Input<string>; /** * Include health warnings. */ includeHealthWarnings?: pulumi.Input<boolean>; /** * NotificationSlack name. */ name?: pulumi.Input<string>; /** * On application update flag. */ onApplicationUpdate?: pulumi.Input<boolean>; /** * On health issue flag. */ onHealthIssue?: pulumi.Input<boolean>; /** * On health restored flag. */ onHealthRestored?: pulumi.Input<boolean>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; /** * Username. */ username: pulumi.Input<string>; /** * URL. */ webHookUrl: pulumi.Input<string>; }