@maienm/pulumi-prowlarr/notifications/join.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 Join resource.
 * For more information refer to [Notification](https://wiki.servarr.com/prowlarr/settings#connect) and [Join](https://wiki.servarr.com/prowlarr/supported#join).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as prowlarr from "@maienm/pulumi-prowlarr";
 *
 * const example = new prowlarr.notifications.Join("example", {
 *     apiKey: "Key",
 *     deviceNames: "device1,device2",
 *     includeHealthWarnings: false,
 *     onApplicationUpdate: false,
 *     onHealthIssue: false,
 *     priority: 2,
 * });
 * ```
 *
 * ## Import
 *
 * import using the API/UI ID
 *
 * ```sh
 *  $ pulumi import prowlarr:Notifications/join:Join example 1
 * ```
 */
export declare class Join extends pulumi.CustomResource {
    /**
     * Get an existing Join 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?: JoinState, opts?: pulumi.CustomResourceOptions): Join;
    /**
     * Returns true if the given object is an instance of Join.  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 Join;
    /**
     * API key.
     */
    readonly apiKey: pulumi.Output<string | undefined>;
    /**
     * Device names. Comma separated list.
     */
    readonly deviceNames: pulumi.Output<string | undefined>;
    /**
     * Include health warnings.
     */
    readonly includeHealthWarnings: pulumi.Output<boolean>;
    /**
     * Include manual grab flag.
     */
    readonly includeManualGrabs: pulumi.Output<boolean>;
    /**
     * NotificationJoin 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>;
    /**
     * Priority. `-2` Silent, `-1` Quiet, `0` Normal, `1` High, `2` Emergency.
     */
    readonly priority: pulumi.Output<number>;
    /**
     * List of associated tags.
     */
    readonly tags: pulumi.Output<number[]>;
    /**
     * Create a Join 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?: JoinArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Join resources.
 */
export interface JoinState {
    /**
     * API key.
     */
    apiKey?: pulumi.Input<string>;
    /**
     * Device names. Comma separated list.
     */
    deviceNames?: pulumi.Input<string>;
    /**
     * Include health warnings.
     */
    includeHealthWarnings?: pulumi.Input<boolean>;
    /**
     * Include manual grab flag.
     */
    includeManualGrabs?: pulumi.Input<boolean>;
    /**
     * NotificationJoin 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>;
    /**
     * Priority. `-2` Silent, `-1` Quiet, `0` Normal, `1` High, `2` Emergency.
     */
    priority?: pulumi.Input<number>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
}
/**
 * The set of arguments for constructing a Join resource.
 */
export interface JoinArgs {
    /**
     * API key.
     */
    apiKey?: pulumi.Input<string>;
    /**
     * Device names. Comma separated list.
     */
    deviceNames?: pulumi.Input<string>;
    /**
     * Include health warnings.
     */
    includeHealthWarnings?: pulumi.Input<boolean>;
    /**
     * Include manual grab flag.
     */
    includeManualGrabs?: pulumi.Input<boolean>;
    /**
     * NotificationJoin 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>;
    /**
     * Priority. `-2` Silent, `-1` Quiet, `0` Normal, `1` High, `2` Emergency.
     */
    priority?: pulumi.Input<number>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
}