@maienm/pulumi-readarr
Version:
A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0
365 lines (364 loc) • 8.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Notifications -->Notification Email resource.
* For more information refer to [Notification](https://wiki.servarr.com/readarr/settings#connect) and [Email](https://wiki.servarr.com/readarr/supported#email).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as readarr from "@maienm/pulumi-readarr";
*
* const example = new readarr.notifications.Email("example", {
* attachFiles: true,
* from: "from_email@example.com",
* onAuthorDelete: false,
* onBookDelete: false,
* onBookFileDelete: false,
* onBookFileDeleteForUpgrade: true,
* onDownloadFailure: false,
* onGrab: false,
* onHealthIssue: false,
* onImportFailure: false,
* onReleaseImport: false,
* onUpgrade: false,
* port: 587,
* server: "http://email-server.net",
* tos: [
* "user1@example.com",
* "user2@example.com",
* ],
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import readarr:Notifications/email:Email example 1
* ```
*/
export declare class Email extends pulumi.CustomResource {
/**
* Get an existing Email 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?: EmailState, opts?: pulumi.CustomResourceOptions): Email;
/**
* Returns true if the given object is an instance of Email. 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 Email;
/**
* Attach files flag.
*/
readonly attachFiles: pulumi.Output<boolean>;
/**
* Bcc.
*/
readonly bccs: pulumi.Output<string[]>;
/**
* Cc.
*/
readonly ccs: pulumi.Output<string[]>;
/**
* From.
*/
readonly from: pulumi.Output<string>;
/**
* Include health warnings.
*/
readonly includeHealthWarnings: pulumi.Output<boolean>;
/**
* Notification name.
*/
readonly name: pulumi.Output<string>;
/**
* On application update flag.
*/
readonly onApplicationUpdate: pulumi.Output<boolean>;
/**
* On author deleted flag.
*/
readonly onAuthorDelete: pulumi.Output<boolean>;
/**
* On book delete flag.
*/
readonly onBookDelete: pulumi.Output<boolean>;
/**
* On book file delete flag.
*/
readonly onBookFileDelete: pulumi.Output<boolean>;
/**
* On book file delete for upgrade flag.
*/
readonly onBookFileDeleteForUpgrade: pulumi.Output<boolean>;
/**
* On download failure flag.
*/
readonly onDownloadFailure: pulumi.Output<boolean>;
/**
* On grab flag.
*/
readonly onGrab: pulumi.Output<boolean>;
/**
* On health issue flag.
*/
readonly onHealthIssue: pulumi.Output<boolean>;
/**
* On import failure flag.
*/
readonly onImportFailure: pulumi.Output<boolean>;
/**
* On release import flag.
*/
readonly onReleaseImport: pulumi.Output<boolean>;
/**
* On upgrade flag.
*/
readonly onUpgrade: pulumi.Output<boolean>;
/**
* Password.
*/
readonly password: pulumi.Output<string>;
/**
* Port.
*/
readonly port: pulumi.Output<number>;
/**
* Require encryption flag.
*/
readonly requireEncryption: pulumi.Output<boolean>;
/**
* Server.
*/
readonly server: pulumi.Output<string>;
/**
* List of associated tags.
*/
readonly tags: pulumi.Output<number[]>;
/**
* To.
*/
readonly tos: pulumi.Output<string[]>;
/**
* Username.
*/
readonly username: pulumi.Output<string>;
/**
* Create a Email 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: EmailArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Email resources.
*/
export interface EmailState {
/**
* Attach files flag.
*/
attachFiles?: pulumi.Input<boolean>;
/**
* Bcc.
*/
bccs?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Cc.
*/
ccs?: pulumi.Input<pulumi.Input<string>[]>;
/**
* From.
*/
from?: pulumi.Input<string>;
/**
* Include health warnings.
*/
includeHealthWarnings?: pulumi.Input<boolean>;
/**
* Notification name.
*/
name?: pulumi.Input<string>;
/**
* On application update flag.
*/
onApplicationUpdate?: pulumi.Input<boolean>;
/**
* On author deleted flag.
*/
onAuthorDelete?: pulumi.Input<boolean>;
/**
* On book delete flag.
*/
onBookDelete?: pulumi.Input<boolean>;
/**
* On book file delete flag.
*/
onBookFileDelete?: pulumi.Input<boolean>;
/**
* On book file delete for upgrade flag.
*/
onBookFileDeleteForUpgrade?: pulumi.Input<boolean>;
/**
* On download failure flag.
*/
onDownloadFailure?: pulumi.Input<boolean>;
/**
* On grab flag.
*/
onGrab?: pulumi.Input<boolean>;
/**
* On health issue flag.
*/
onHealthIssue?: pulumi.Input<boolean>;
/**
* On import failure flag.
*/
onImportFailure?: pulumi.Input<boolean>;
/**
* On release import flag.
*/
onReleaseImport?: pulumi.Input<boolean>;
/**
* On upgrade flag.
*/
onUpgrade?: pulumi.Input<boolean>;
/**
* Password.
*/
password?: pulumi.Input<string>;
/**
* Port.
*/
port?: pulumi.Input<number>;
/**
* Require encryption flag.
*/
requireEncryption?: pulumi.Input<boolean>;
/**
* Server.
*/
server?: pulumi.Input<string>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* To.
*/
tos?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Username.
*/
username?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Email resource.
*/
export interface EmailArgs {
/**
* Attach files flag.
*/
attachFiles?: pulumi.Input<boolean>;
/**
* Bcc.
*/
bccs?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Cc.
*/
ccs?: pulumi.Input<pulumi.Input<string>[]>;
/**
* From.
*/
from: pulumi.Input<string>;
/**
* Include health warnings.
*/
includeHealthWarnings?: pulumi.Input<boolean>;
/**
* Notification name.
*/
name?: pulumi.Input<string>;
/**
* On application update flag.
*/
onApplicationUpdate?: pulumi.Input<boolean>;
/**
* On author deleted flag.
*/
onAuthorDelete?: pulumi.Input<boolean>;
/**
* On book delete flag.
*/
onBookDelete?: pulumi.Input<boolean>;
/**
* On book file delete flag.
*/
onBookFileDelete?: pulumi.Input<boolean>;
/**
* On book file delete for upgrade flag.
*/
onBookFileDeleteForUpgrade?: pulumi.Input<boolean>;
/**
* On download failure flag.
*/
onDownloadFailure?: pulumi.Input<boolean>;
/**
* On grab flag.
*/
onGrab?: pulumi.Input<boolean>;
/**
* On health issue flag.
*/
onHealthIssue?: pulumi.Input<boolean>;
/**
* On import failure flag.
*/
onImportFailure?: pulumi.Input<boolean>;
/**
* On release import flag.
*/
onReleaseImport?: pulumi.Input<boolean>;
/**
* On upgrade flag.
*/
onUpgrade?: pulumi.Input<boolean>;
/**
* Password.
*/
password?: pulumi.Input<string>;
/**
* Port.
*/
port?: pulumi.Input<number>;
/**
* Require encryption flag.
*/
requireEncryption?: pulumi.Input<boolean>;
/**
* Server.
*/
server: pulumi.Input<string>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* To.
*/
tos: pulumi.Input<pulumi.Input<string>[]>;
/**
* Username.
*/
username?: pulumi.Input<string>;
}