@maienm/pulumi-prowlarr
Version:
A Pulumi package for creating and managing Prowlarr resources. Based on terraform-provider-prowlarr: version v2.3.0
1,073 lines (1,072 loc) • 23 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Notifications -->Generic Notification resource. When possible use a specific resource instead.
* For more information refer to [Notification](https://wiki.servarr.com/prowlarr/settings#connect).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as prowlarr from "@maienm/pulumi-prowlarr";
*
* const example = new prowlarr.notifications.Notification("example", {
* configContract: "CustomScriptSettings",
* implementation: "CustomScript",
* includeHealthWarnings: false,
* onApplicationUpdate: false,
* onHealthIssue: false,
* path: "/scripts/prowlarr.sh",
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import prowlarr:Notifications/notification:Notification example 1
* ```
*/
export declare class Notification extends pulumi.CustomResource {
/**
* Get an existing Notification 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?: NotificationState, opts?: pulumi.CustomResourceOptions): Notification;
/**
* Returns true if the given object is an instance of Notification. 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 Notification;
/**
* Access token.
*/
readonly accessToken: pulumi.Output<string>;
/**
* Access token secret.
*/
readonly accessTokenSecret: pulumi.Output<string>;
/**
* Always update flag.
*/
readonly alwaysUpdate: pulumi.Output<boolean>;
/**
* API key.
*/
readonly apiKey: pulumi.Output<string>;
/**
* App token.
*/
readonly appToken: pulumi.Output<string>;
/**
* Arguments.
*/
readonly arguments: pulumi.Output<string>;
/**
* Auth password.
*/
readonly authPassword: pulumi.Output<string>;
/**
* Auth token.
*/
readonly authToken: pulumi.Output<string>;
/**
* Auth user.
*/
readonly authUser: pulumi.Output<string>;
/**
* Auth username.
*/
readonly authUsername: pulumi.Output<string>;
/**
* Author.
*/
readonly author: pulumi.Output<string>;
/**
* Avatar.
*/
readonly avatar: pulumi.Output<string>;
/**
* Base URL.
*/
readonly baseUrl: pulumi.Output<string>;
/**
* Bcc.
*/
readonly bccs: pulumi.Output<string[]>;
/**
* Bot token.
*/
readonly botToken: pulumi.Output<string>;
/**
* Cc.
*/
readonly ccs: pulumi.Output<string[]>;
/**
* Channel.
*/
readonly channel: pulumi.Output<string>;
/**
* Channel tags.
*/
readonly channelTags: pulumi.Output<string[]>;
/**
* Chat ID.
*/
readonly chatId: pulumi.Output<string>;
/**
* Clean library flag.
*/
readonly cleanLibrary: pulumi.Output<boolean>;
/**
* Click URL.
*/
readonly clickUrl: pulumi.Output<string>;
/**
* Notification configuration template.
*/
readonly configContract: pulumi.Output<string>;
/**
* Configuration key.
*/
readonly configurationKey: pulumi.Output<string>;
/**
* Consumer key.
*/
readonly consumerKey: pulumi.Output<string>;
/**
* Consumer secret.
*/
readonly consumerSecret: pulumi.Output<string>;
/**
* Device IDs.
*/
readonly deviceIds: pulumi.Output<number[]>;
/**
* Device names.
*/
readonly deviceNames: pulumi.Output<string>;
/**
* Devices.
*/
readonly devices: pulumi.Output<string[]>;
/**
* Direct message flag.
*/
readonly directMessage: pulumi.Output<boolean>;
/**
* Display time.
*/
readonly displayTime: pulumi.Output<number>;
/**
* Event.
*/
readonly event: pulumi.Output<string>;
/**
* Expire.
*/
readonly expire: pulumi.Output<number>;
/**
* Expires.
*/
readonly expires: pulumi.Output<string>;
/**
* Devices.
*/
readonly fieldTags: pulumi.Output<string[]>;
/**
* From.
*/
readonly from: pulumi.Output<string>;
/**
* Grab fields. `0` Overview, `1` Rating, `2` Genres, `3` Quality, `4` Group, `5` Size, `6` Links, `7` Release, `8` Poster, `9` Fanart.
*/
readonly grabFields: pulumi.Output<number[]>;
/**
* Host.
*/
readonly host: pulumi.Output<string>;
/**
* Icon.
*/
readonly icon: pulumi.Output<string>;
/**
* Notification implementation name.
*/
readonly implementation: pulumi.Output<string>;
/**
* Include health warnings.
*/
readonly includeHealthWarnings: pulumi.Output<boolean>;
/**
* Include manual grab flag.
*/
readonly includeManualGrabs: pulumi.Output<boolean>;
/**
* Instance name.
*/
readonly instanceName: pulumi.Output<string>;
/**
* Key.
*/
readonly key: pulumi.Output<string>;
/**
* Map From.
*/
readonly mapFrom: pulumi.Output<string>;
/**
* Map To.
*/
readonly mapTo: pulumi.Output<string>;
/**
* Mention.
*/
readonly mention: pulumi.Output<string>;
/**
* Method. `1` POST, `2` PUT.
*/
readonly method: pulumi.Output<number>;
/**
* Notification name.
*/
readonly name: pulumi.Output<string>;
/**
* Notification type. `0` Info, `1` Success, `2` Warning, `3` Failure.
*/
readonly notificationType: pulumi.Output<number>;
/**
* Notify flag.
*/
readonly notify: pulumi.Output<boolean>;
/**
* 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>;
/**
* Path.
*/
readonly path: pulumi.Output<string>;
/**
* Port.
*/
readonly port: pulumi.Output<number>;
/**
* Priority.
*/
readonly priority: pulumi.Output<number>;
/**
* Receiver ID.
*/
readonly receiverId: pulumi.Output<string>;
/**
* Recipients.
*/
readonly recipients: pulumi.Output<string[]>;
/**
* Refresh token.
*/
readonly refreshToken: pulumi.Output<string>;
/**
* Retry.
*/
readonly retry: pulumi.Output<number>;
/**
* Add silently flag.
*/
readonly sendSilently: pulumi.Output<boolean>;
/**
* Sender domain.
*/
readonly senderDomain: pulumi.Output<string>;
/**
* Sender ID.
*/
readonly senderId: pulumi.Output<string>;
/**
* Sender Number.
*/
readonly senderNumber: pulumi.Output<string>;
/**
* server.
*/
readonly server: pulumi.Output<string>;
/**
* Server url.
*/
readonly serverUrl: pulumi.Output<string>;
/**
* Sign in.
*/
readonly signIn: pulumi.Output<string>;
/**
* Sound.
*/
readonly sound: pulumi.Output<string>;
/**
* Comma separated stateless URLs.
*/
readonly statelessUrls: pulumi.Output<string>;
/**
* List of associated tags.
*/
readonly tags: pulumi.Output<number[]>;
/**
* Token.
*/
readonly token: pulumi.Output<string>;
/**
* Topic ID.
*/
readonly topicId: pulumi.Output<string>;
/**
* Devices.
*/
readonly topics: pulumi.Output<string[]>;
/**
* To.
*/
readonly tos: pulumi.Output<string[]>;
/**
* Update library flag.
*/
readonly updateLibrary: pulumi.Output<boolean>;
/**
* URL.
*/
readonly url: pulumi.Output<string>;
/**
* Use Encryption. `0` Preferred, `1` Always, `2` Never.
*/
readonly useEncryption: pulumi.Output<number>;
/**
* Use EU endpoint flag.
*/
readonly useEuEndpoint: pulumi.Output<boolean>;
/**
* Use SSL flag.
*/
readonly useSsl: pulumi.Output<boolean>;
/**
* User key.
*/
readonly userKey: pulumi.Output<string>;
/**
* Username.
*/
readonly username: pulumi.Output<string>;
/**
* Web hook url.
*/
readonly webHookUrl: pulumi.Output<string>;
/**
* Create a Notification 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: NotificationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Notification resources.
*/
export interface NotificationState {
/**
* Access token.
*/
accessToken?: pulumi.Input<string>;
/**
* Access token secret.
*/
accessTokenSecret?: pulumi.Input<string>;
/**
* Always update flag.
*/
alwaysUpdate?: pulumi.Input<boolean>;
/**
* API key.
*/
apiKey?: pulumi.Input<string>;
/**
* App token.
*/
appToken?: pulumi.Input<string>;
/**
* Arguments.
*/
arguments?: pulumi.Input<string>;
/**
* Auth password.
*/
authPassword?: pulumi.Input<string>;
/**
* Auth token.
*/
authToken?: pulumi.Input<string>;
/**
* Auth user.
*/
authUser?: pulumi.Input<string>;
/**
* Auth username.
*/
authUsername?: pulumi.Input<string>;
/**
* Author.
*/
author?: pulumi.Input<string>;
/**
* Avatar.
*/
avatar?: pulumi.Input<string>;
/**
* Base URL.
*/
baseUrl?: pulumi.Input<string>;
/**
* Bcc.
*/
bccs?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Bot token.
*/
botToken?: pulumi.Input<string>;
/**
* Cc.
*/
ccs?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Channel.
*/
channel?: pulumi.Input<string>;
/**
* Channel tags.
*/
channelTags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Chat ID.
*/
chatId?: pulumi.Input<string>;
/**
* Clean library flag.
*/
cleanLibrary?: pulumi.Input<boolean>;
/**
* Click URL.
*/
clickUrl?: pulumi.Input<string>;
/**
* Notification configuration template.
*/
configContract?: pulumi.Input<string>;
/**
* Configuration key.
*/
configurationKey?: pulumi.Input<string>;
/**
* Consumer key.
*/
consumerKey?: pulumi.Input<string>;
/**
* Consumer secret.
*/
consumerSecret?: pulumi.Input<string>;
/**
* Device IDs.
*/
deviceIds?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Device names.
*/
deviceNames?: pulumi.Input<string>;
/**
* Devices.
*/
devices?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Direct message flag.
*/
directMessage?: pulumi.Input<boolean>;
/**
* Display time.
*/
displayTime?: pulumi.Input<number>;
/**
* Event.
*/
event?: pulumi.Input<string>;
/**
* Expire.
*/
expire?: pulumi.Input<number>;
/**
* Expires.
*/
expires?: pulumi.Input<string>;
/**
* Devices.
*/
fieldTags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* From.
*/
from?: pulumi.Input<string>;
/**
* Grab fields. `0` Overview, `1` Rating, `2` Genres, `3` Quality, `4` Group, `5` Size, `6` Links, `7` Release, `8` Poster, `9` Fanart.
*/
grabFields?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Host.
*/
host?: pulumi.Input<string>;
/**
* Icon.
*/
icon?: pulumi.Input<string>;
/**
* Notification implementation name.
*/
implementation?: pulumi.Input<string>;
/**
* Include health warnings.
*/
includeHealthWarnings?: pulumi.Input<boolean>;
/**
* Include manual grab flag.
*/
includeManualGrabs?: pulumi.Input<boolean>;
/**
* Instance name.
*/
instanceName?: pulumi.Input<string>;
/**
* Key.
*/
key?: pulumi.Input<string>;
/**
* Map From.
*/
mapFrom?: pulumi.Input<string>;
/**
* Map To.
*/
mapTo?: pulumi.Input<string>;
/**
* Mention.
*/
mention?: pulumi.Input<string>;
/**
* Method. `1` POST, `2` PUT.
*/
method?: pulumi.Input<number>;
/**
* Notification name.
*/
name?: pulumi.Input<string>;
/**
* Notification type. `0` Info, `1` Success, `2` Warning, `3` Failure.
*/
notificationType?: pulumi.Input<number>;
/**
* Notify flag.
*/
notify?: pulumi.Input<boolean>;
/**
* 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>;
/**
* Path.
*/
path?: pulumi.Input<string>;
/**
* Port.
*/
port?: pulumi.Input<number>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Receiver ID.
*/
receiverId?: pulumi.Input<string>;
/**
* Recipients.
*/
recipients?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Refresh token.
*/
refreshToken?: pulumi.Input<string>;
/**
* Retry.
*/
retry?: pulumi.Input<number>;
/**
* Add silently flag.
*/
sendSilently?: pulumi.Input<boolean>;
/**
* Sender domain.
*/
senderDomain?: pulumi.Input<string>;
/**
* Sender ID.
*/
senderId?: pulumi.Input<string>;
/**
* Sender Number.
*/
senderNumber?: pulumi.Input<string>;
/**
* server.
*/
server?: pulumi.Input<string>;
/**
* Server url.
*/
serverUrl?: pulumi.Input<string>;
/**
* Sign in.
*/
signIn?: pulumi.Input<string>;
/**
* Sound.
*/
sound?: pulumi.Input<string>;
/**
* Comma separated stateless URLs.
*/
statelessUrls?: pulumi.Input<string>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Token.
*/
token?: pulumi.Input<string>;
/**
* Topic ID.
*/
topicId?: pulumi.Input<string>;
/**
* Devices.
*/
topics?: pulumi.Input<pulumi.Input<string>[]>;
/**
* To.
*/
tos?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Update library flag.
*/
updateLibrary?: pulumi.Input<boolean>;
/**
* URL.
*/
url?: pulumi.Input<string>;
/**
* Use Encryption. `0` Preferred, `1` Always, `2` Never.
*/
useEncryption?: pulumi.Input<number>;
/**
* Use EU endpoint flag.
*/
useEuEndpoint?: pulumi.Input<boolean>;
/**
* Use SSL flag.
*/
useSsl?: pulumi.Input<boolean>;
/**
* User key.
*/
userKey?: pulumi.Input<string>;
/**
* Username.
*/
username?: pulumi.Input<string>;
/**
* Web hook url.
*/
webHookUrl?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Notification resource.
*/
export interface NotificationArgs {
/**
* Access token.
*/
accessToken?: pulumi.Input<string>;
/**
* Access token secret.
*/
accessTokenSecret?: pulumi.Input<string>;
/**
* Always update flag.
*/
alwaysUpdate?: pulumi.Input<boolean>;
/**
* API key.
*/
apiKey?: pulumi.Input<string>;
/**
* App token.
*/
appToken?: pulumi.Input<string>;
/**
* Arguments.
*/
arguments?: pulumi.Input<string>;
/**
* Auth password.
*/
authPassword?: pulumi.Input<string>;
/**
* Auth token.
*/
authToken?: pulumi.Input<string>;
/**
* Auth user.
*/
authUser?: pulumi.Input<string>;
/**
* Auth username.
*/
authUsername?: pulumi.Input<string>;
/**
* Author.
*/
author?: pulumi.Input<string>;
/**
* Avatar.
*/
avatar?: pulumi.Input<string>;
/**
* Base URL.
*/
baseUrl?: pulumi.Input<string>;
/**
* Bcc.
*/
bccs?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Bot token.
*/
botToken?: pulumi.Input<string>;
/**
* Cc.
*/
ccs?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Channel.
*/
channel?: pulumi.Input<string>;
/**
* Channel tags.
*/
channelTags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Chat ID.
*/
chatId?: pulumi.Input<string>;
/**
* Clean library flag.
*/
cleanLibrary?: pulumi.Input<boolean>;
/**
* Click URL.
*/
clickUrl?: pulumi.Input<string>;
/**
* Notification configuration template.
*/
configContract: pulumi.Input<string>;
/**
* Configuration key.
*/
configurationKey?: pulumi.Input<string>;
/**
* Consumer key.
*/
consumerKey?: pulumi.Input<string>;
/**
* Consumer secret.
*/
consumerSecret?: pulumi.Input<string>;
/**
* Device IDs.
*/
deviceIds?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Device names.
*/
deviceNames?: pulumi.Input<string>;
/**
* Devices.
*/
devices?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Direct message flag.
*/
directMessage?: pulumi.Input<boolean>;
/**
* Display time.
*/
displayTime?: pulumi.Input<number>;
/**
* Event.
*/
event?: pulumi.Input<string>;
/**
* Expire.
*/
expire?: pulumi.Input<number>;
/**
* Expires.
*/
expires?: pulumi.Input<string>;
/**
* Devices.
*/
fieldTags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* From.
*/
from?: pulumi.Input<string>;
/**
* Grab fields. `0` Overview, `1` Rating, `2` Genres, `3` Quality, `4` Group, `5` Size, `6` Links, `7` Release, `8` Poster, `9` Fanart.
*/
grabFields?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Host.
*/
host?: pulumi.Input<string>;
/**
* Icon.
*/
icon?: pulumi.Input<string>;
/**
* Notification implementation name.
*/
implementation: pulumi.Input<string>;
/**
* Include health warnings.
*/
includeHealthWarnings: pulumi.Input<boolean>;
/**
* Include manual grab flag.
*/
includeManualGrabs?: pulumi.Input<boolean>;
/**
* Instance name.
*/
instanceName?: pulumi.Input<string>;
/**
* Key.
*/
key?: pulumi.Input<string>;
/**
* Map From.
*/
mapFrom?: pulumi.Input<string>;
/**
* Map To.
*/
mapTo?: pulumi.Input<string>;
/**
* Mention.
*/
mention?: pulumi.Input<string>;
/**
* Method. `1` POST, `2` PUT.
*/
method?: pulumi.Input<number>;
/**
* Notification name.
*/
name?: pulumi.Input<string>;
/**
* Notification type. `0` Info, `1` Success, `2` Warning, `3` Failure.
*/
notificationType?: pulumi.Input<number>;
/**
* Notify flag.
*/
notify?: pulumi.Input<boolean>;
/**
* 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>;
/**
* Path.
*/
path?: pulumi.Input<string>;
/**
* Port.
*/
port?: pulumi.Input<number>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Receiver ID.
*/
receiverId?: pulumi.Input<string>;
/**
* Recipients.
*/
recipients?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Refresh token.
*/
refreshToken?: pulumi.Input<string>;
/**
* Retry.
*/
retry?: pulumi.Input<number>;
/**
* Add silently flag.
*/
sendSilently?: pulumi.Input<boolean>;
/**
* Sender domain.
*/
senderDomain?: pulumi.Input<string>;
/**
* Sender ID.
*/
senderId?: pulumi.Input<string>;
/**
* Sender Number.
*/
senderNumber?: pulumi.Input<string>;
/**
* server.
*/
server?: pulumi.Input<string>;
/**
* Server url.
*/
serverUrl?: pulumi.Input<string>;
/**
* Sign in.
*/
signIn?: pulumi.Input<string>;
/**
* Sound.
*/
sound?: pulumi.Input<string>;
/**
* Comma separated stateless URLs.
*/
statelessUrls?: pulumi.Input<string>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Token.
*/
token?: pulumi.Input<string>;
/**
* Topic ID.
*/
topicId?: pulumi.Input<string>;
/**
* Devices.
*/
topics?: pulumi.Input<pulumi.Input<string>[]>;
/**
* To.
*/
tos?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Update library flag.
*/
updateLibrary?: pulumi.Input<boolean>;
/**
* URL.
*/
url?: pulumi.Input<string>;
/**
* Use Encryption. `0` Preferred, `1` Always, `2` Never.
*/
useEncryption?: pulumi.Input<number>;
/**
* Use EU endpoint flag.
*/
useEuEndpoint?: pulumi.Input<boolean>;
/**
* Use SSL flag.
*/
useSsl?: pulumi.Input<boolean>;
/**
* User key.
*/
userKey?: pulumi.Input<string>;
/**
* Username.
*/
username?: pulumi.Input<string>;
/**
* Web hook url.
*/
webHookUrl?: pulumi.Input<string>;
}