@maienm/pulumi-prowlarr
Version:
A Pulumi package for creating and managing Prowlarr resources. Based on terraform-provider-prowlarr: version v2.3.0
266 lines (265 loc) • 6.73 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Notifications -->Notification Ntfy resource.
* For more information refer to [Notification](https://wiki.servarr.com/prowlarr/settings#connect) and [Ntfy](https://wiki.servarr.com/prowlarr/supported#ntfy).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as prowlarr from "@maienm/pulumi-prowlarr";
*
* const example = new prowlarr.notifications.Ntfy("example", {
* fieldTags: [
* "warning",
* "skull",
* ],
* includeHealthWarnings: false,
* onApplicationUpdate: false,
* onHealthIssue: false,
* password: "Pass",
* priority: 1,
* serverUrl: "https://ntfy.sh",
* topics: [
* "Topic1234",
* "Topic4321",
* ],
* username: "User",
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import prowlarr:Notifications/ntfy:Ntfy example 1
* ```
*/
export declare class Ntfy extends pulumi.CustomResource {
/**
* Get an existing Ntfy 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?: NtfyState, opts?: pulumi.CustomResourceOptions): Ntfy;
/**
* Returns true if the given object is an instance of Ntfy. 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 Ntfy;
/**
* Access token.
*/
readonly accessToken: pulumi.Output<string>;
/**
* Click URL.
*/
readonly clickUrl: 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>;
/**
* NotificationNtfy 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>;
/**
* Priority. `1` Min, `2` Low, `3` Default, `4` High, `5` Max.
*/
readonly priority: pulumi.Output<number>;
/**
* Server URL.
*/
readonly serverUrl: pulumi.Output<string>;
/**
* List of associated tags.
*/
readonly tags: pulumi.Output<number[]>;
/**
* Topics.
*/
readonly topics: pulumi.Output<string[]>;
/**
* Username.
*/
readonly username: pulumi.Output<string>;
/**
* Create a Ntfy 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: NtfyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Ntfy resources.
*/
export interface NtfyState {
/**
* Access token.
*/
accessToken?: pulumi.Input<string>;
/**
* Click URL.
*/
clickUrl?: 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>;
/**
* NotificationNtfy 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>;
/**
* Priority. `1` Min, `2` Low, `3` Default, `4` High, `5` Max.
*/
priority?: pulumi.Input<number>;
/**
* Server URL.
*/
serverUrl?: pulumi.Input<string>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Topics.
*/
topics?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Username.
*/
username?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Ntfy resource.
*/
export interface NtfyArgs {
/**
* Access token.
*/
accessToken?: pulumi.Input<string>;
/**
* Click URL.
*/
clickUrl?: 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>;
/**
* NotificationNtfy 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>;
/**
* Priority. `1` Min, `2` Low, `3` Default, `4` High, `5` Max.
*/
priority?: pulumi.Input<number>;
/**
* Server URL.
*/
serverUrl?: pulumi.Input<string>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Topics.
*/
topics: pulumi.Input<pulumi.Input<string>[]>;
/**
* Username.
*/
username?: pulumi.Input<string>;
}