@maienm/pulumi-prowlarr/notifications/mailgun.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 Mailgun resource.
 * For more information refer to [Notification](https://wiki.servarr.com/prowlarr/settings#connect) and [Mailgun](https://wiki.servarr.com/prowlarr/supported#mailgun).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as prowlarr from "@maienm/pulumi-prowlarr";
 *
 * const example = new prowlarr.notifications.Mailgun("example", {
 *     apiKey: "APIkey",
 *     from: "from_mailgun@example.com",
 *     includeHealthWarnings: false,
 *     onApplicationUpdate: false,
 *     onHealthIssue: false,
 *     recipients: [
 *         "user1@example.com",
 *         "user2@example.com",
 *     ],
 * });
 * ```
 *
 * ## Import
 *
 * import using the API/UI ID
 *
 * ```sh
 *  $ pulumi import prowlarr:Notifications/mailgun:Mailgun example 1
 * ```
 */
export declare class Mailgun extends pulumi.CustomResource {
    /**
     * Get an existing Mailgun 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?: MailgunState, opts?: pulumi.CustomResourceOptions): Mailgun;
    /**
     * Returns true if the given object is an instance of Mailgun.  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 Mailgun;
    /**
     * API key.
     */
    readonly apiKey: pulumi.Output<string>;
    /**
     * From.
     */
    readonly from: pulumi.Output<string>;
    /**
     * Include health warnings.
     */
    readonly includeHealthWarnings: pulumi.Output<boolean>;
    /**
     * NotificationMailgun name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * On application update flag.
     */
    readonly onApplicationUpdate: pulumi.Output<boolean>;
    /**
     * On health issue flag.
     */
    readonly onHealthIssue: pulumi.Output<boolean>;
    /**
     * On health restored flag.
     */
    readonly onHealthRestored: pulumi.Output<boolean>;
    /**
     * Recipients.
     */
    readonly recipients: pulumi.Output<string[]>;
    /**
     * Sender domain.
     */
    readonly senderDomain: pulumi.Output<string>;
    /**
     * List of associated tags.
     */
    readonly tags: pulumi.Output<number[]>;
    /**
     * Use EU endpoint flag.
     */
    readonly useEuEndpoint: pulumi.Output<boolean>;
    /**
     * Create a Mailgun 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: MailgunArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Mailgun resources.
 */
export interface MailgunState {
    /**
     * API key.
     */
    apiKey?: pulumi.Input<string>;
    /**
     * From.
     */
    from?: pulumi.Input<string>;
    /**
     * Include health warnings.
     */
    includeHealthWarnings?: pulumi.Input<boolean>;
    /**
     * NotificationMailgun name.
     */
    name?: pulumi.Input<string>;
    /**
     * On application update flag.
     */
    onApplicationUpdate?: pulumi.Input<boolean>;
    /**
     * On health issue flag.
     */
    onHealthIssue?: pulumi.Input<boolean>;
    /**
     * On health restored flag.
     */
    onHealthRestored?: pulumi.Input<boolean>;
    /**
     * Recipients.
     */
    recipients?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Sender domain.
     */
    senderDomain?: pulumi.Input<string>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Use EU endpoint flag.
     */
    useEuEndpoint?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a Mailgun resource.
 */
export interface MailgunArgs {
    /**
     * API key.
     */
    apiKey?: pulumi.Input<string>;
    /**
     * From.
     */
    from: pulumi.Input<string>;
    /**
     * Include health warnings.
     */
    includeHealthWarnings?: pulumi.Input<boolean>;
    /**
     * NotificationMailgun name.
     */
    name?: pulumi.Input<string>;
    /**
     * On application update flag.
     */
    onApplicationUpdate?: pulumi.Input<boolean>;
    /**
     * On health issue flag.
     */
    onHealthIssue?: pulumi.Input<boolean>;
    /**
     * On health restored flag.
     */
    onHealthRestored?: pulumi.Input<boolean>;
    /**
     * Recipients.
     */
    recipients: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Sender domain.
     */
    senderDomain?: pulumi.Input<string>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Use EU endpoint flag.
     */
    useEuEndpoint?: pulumi.Input<boolean>;
}