@maienm/pulumi-prowlarr/notifications/webhook.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * <!-- subcategory:Notifications -->Notification Webhook resource.
 * For more information refer to [Notification](https://wiki.servarr.com/prowlarr/settings#connect) and [Webhook](https://wiki.servarr.com/prowlarr/supported#webhook).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as prowlarr from "@maienm/pulumi-prowlarr";
 *
 * const example = new prowlarr.notifications.Webhook("example", {
 *     includeHealthWarnings: false,
 *     method: 1,
 *     onApplicationUpdate: false,
 *     onHealthIssue: false,
 *     password: "examplePass",
 *     url: "https://example.webhook.com/example",
 *     username: "exampleUser",
 * });
 * ```
 *
 * ## Import
 *
 * import using the API/UI ID
 *
 * ```sh
 *  $ pulumi import prowlarr:Notifications/webhook:Webhook example 1
 * ```
 */
export declare class Webhook extends pulumi.CustomResource {
    /**
     * Get an existing Webhook 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?: WebhookState, opts?: pulumi.CustomResourceOptions): Webhook;
    /**
     * Returns true if the given object is an instance of Webhook.  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 Webhook;
    /**
     * Include health warnings.
     */
    readonly includeHealthWarnings: pulumi.Output<boolean>;
    /**
     * Include manual grab flag.
     */
    readonly includeManualGrabs: pulumi.Output<boolean>;
    /**
     * Method. `1` POST, `2` PUT.
     */
    readonly method: pulumi.Output<number>;
    /**
     * NotificationWebhook 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>;
    /**
     * password.
     */
    readonly password: pulumi.Output<string>;
    /**
     * List of associated tags.
     */
    readonly tags: pulumi.Output<number[]>;
    /**
     * URL.
     */
    readonly url: pulumi.Output<string>;
    /**
     * Username.
     */
    readonly username: pulumi.Output<string>;
    /**
     * Create a Webhook 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: WebhookArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Webhook resources.
 */
export interface WebhookState {
    /**
     * Include health warnings.
     */
    includeHealthWarnings?: pulumi.Input<boolean>;
    /**
     * Include manual grab flag.
     */
    includeManualGrabs?: pulumi.Input<boolean>;
    /**
     * Method. `1` POST, `2` PUT.
     */
    method?: pulumi.Input<number>;
    /**
     * NotificationWebhook 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>;
    /**
     * password.
     */
    password?: pulumi.Input<string>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * URL.
     */
    url?: pulumi.Input<string>;
    /**
     * Username.
     */
    username?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Webhook resource.
 */
export interface WebhookArgs {
    /**
     * Include health warnings.
     */
    includeHealthWarnings: pulumi.Input<boolean>;
    /**
     * Include manual grab flag.
     */
    includeManualGrabs?: pulumi.Input<boolean>;
    /**
     * Method. `1` POST, `2` PUT.
     */
    method: pulumi.Input<number>;
    /**
     * NotificationWebhook 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>;
    /**
     * password.
     */
    password?: pulumi.Input<string>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * URL.
     */
    url: pulumi.Input<string>;
    /**
     * Username.
     */
    username?: pulumi.Input<string>;
}