@maienm/pulumi-prowlarr
Version:
A Pulumi package for creating and managing Prowlarr resources. Based on terraform-provider-prowlarr: version v2.3.0
250 lines (249 loc) • 6.71 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Notifications -->Notification Apprise resource.
* For more information refer to [Notification](https://wiki.servarr.com/prowlarr/settings#connect) and [Apprise](https://wiki.servarr.com/prowlarr/supported#apprise).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as prowlarr from "@maienm/pulumi-prowlarr";
*
* const example = new prowlarr.notifications.Apprise("example", {
* authPassword: "Pass",
* authUsername: "User",
* configurationKey: "ConfigKey",
* fieldTags: [
* "test",
* "test1",
* ],
* includeHealthWarnings: false,
* onApplicationUpdate: false,
* onHealthIssue: false,
* serverUrl: "http://localhost:8000",
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import prowlarr:Notifications/apprise:Apprise example 1
* ```
*/
export declare class Apprise extends pulumi.CustomResource {
/**
* Get an existing Apprise 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?: AppriseState, opts?: pulumi.CustomResourceOptions): Apprise;
/**
* Returns true if the given object is an instance of Apprise. 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 Apprise;
/**
* AuthPassword.
*/
readonly authPassword: pulumi.Output<string>;
/**
* AuthUsername.
*/
readonly authUsername: pulumi.Output<string>;
/**
* ConfigurationKey.
*/
readonly configurationKey: pulumi.Output<string>;
/**
* Tags and emojis.
*/
readonly fieldTags: pulumi.Output<string[]>;
/**
* Include health warnings.
*/
readonly includeHealthWarnings: pulumi.Output<boolean>;
/**
* Include manual grab flag.
*/
readonly includeManualGrabs: pulumi.Output<boolean>;
/**
* NotificationApprise name.
*/
readonly name: pulumi.Output<string>;
/**
* Notification type. `0` Info, `1` Success, `2` Warning, `3` Failure.
*/
readonly notificationType: pulumi.Output<number>;
/**
* 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>;
/**
* Server URL.
*/
readonly serverUrl: pulumi.Output<string>;
/**
* Comma separated stateless URLs.
*/
readonly statelessUrls: pulumi.Output<string>;
/**
* List of associated tags.
*/
readonly tags: pulumi.Output<number[]>;
/**
* Create a Apprise 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?: AppriseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Apprise resources.
*/
export interface AppriseState {
/**
* AuthPassword.
*/
authPassword?: pulumi.Input<string>;
/**
* AuthUsername.
*/
authUsername?: pulumi.Input<string>;
/**
* ConfigurationKey.
*/
configurationKey?: pulumi.Input<string>;
/**
* Tags and emojis.
*/
fieldTags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Include health warnings.
*/
includeHealthWarnings?: pulumi.Input<boolean>;
/**
* Include manual grab flag.
*/
includeManualGrabs?: pulumi.Input<boolean>;
/**
* NotificationApprise name.
*/
name?: pulumi.Input<string>;
/**
* Notification type. `0` Info, `1` Success, `2` Warning, `3` Failure.
*/
notificationType?: pulumi.Input<number>;
/**
* 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>;
/**
* Server URL.
*/
serverUrl?: pulumi.Input<string>;
/**
* Comma separated stateless URLs.
*/
statelessUrls?: pulumi.Input<string>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
}
/**
* The set of arguments for constructing a Apprise resource.
*/
export interface AppriseArgs {
/**
* AuthPassword.
*/
authPassword?: pulumi.Input<string>;
/**
* AuthUsername.
*/
authUsername?: pulumi.Input<string>;
/**
* ConfigurationKey.
*/
configurationKey?: pulumi.Input<string>;
/**
* Tags and emojis.
*/
fieldTags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Include health warnings.
*/
includeHealthWarnings?: pulumi.Input<boolean>;
/**
* Include manual grab flag.
*/
includeManualGrabs?: pulumi.Input<boolean>;
/**
* NotificationApprise name.
*/
name?: pulumi.Input<string>;
/**
* Notification type. `0` Info, `1` Success, `2` Warning, `3` Failure.
*/
notificationType?: pulumi.Input<number>;
/**
* 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>;
/**
* Server URL.
*/
serverUrl?: pulumi.Input<string>;
/**
* Comma separated stateless URLs.
*/
statelessUrls?: pulumi.Input<string>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
}