@maienm/pulumi-prowlarr/downloadclients/freebox.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";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * <!-- subcategory:Download Clients -->Download Client Freebox resource.
 * For more information refer to [Download Client](https://wiki.servarr.com/prowlarr/settings#download-clients) and [Freebox](https://wiki.servarr.com/prowlarr/supported#torrentfreeboxdownload).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as prowlarr from "@maienm/pulumi-prowlarr";
 *
 * const example = new prowlarr.downloadclients.Freebox("example", {
 *     apiUrl: "/api/v1/",
 *     appId: "freebox",
 *     appToken: "Token123",
 *     enable: true,
 *     host: "mafreebox.freebox.fr",
 *     port: 443,
 *     priority: 1,
 * });
 * ```
 *
 * ## Import
 *
 * import using the API/UI ID
 *
 * ```sh
 *  $ pulumi import prowlarr:DownloadClients/freebox:Freebox example 1
 * ```
 */
export declare class Freebox extends pulumi.CustomResource {
    /**
     * Get an existing Freebox 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?: FreeboxState, opts?: pulumi.CustomResourceOptions): Freebox;
    /**
     * Returns true if the given object is an instance of Freebox.  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 Freebox;
    /**
     * Add paused flag.
     */
    readonly addPaused: pulumi.Output<boolean>;
    /**
     * API URL.
     */
    readonly apiUrl: pulumi.Output<string>;
    /**
     * App ID.
     */
    readonly appId: pulumi.Output<string>;
    /**
     * App Token.
     */
    readonly appToken: pulumi.Output<string>;
    /**
     * List of categories.
     */
    readonly categories: pulumi.Output<outputs.DownloadClients.FreeboxCategory[]>;
    /**
     * category.
     */
    readonly category: pulumi.Output<string>;
    /**
     * Movie directory.
     */
    readonly destinationDirectory: pulumi.Output<string>;
    /**
     * Enable flag.
     */
    readonly enable: pulumi.Output<boolean>;
    /**
     * host.
     */
    readonly host: pulumi.Output<string>;
    /**
     * Recent Movie priority. `0` Last, `1` First.
     */
    readonly itemPriority: pulumi.Output<number>;
    /**
     * Name of client category.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Port.
     */
    readonly port: pulumi.Output<number>;
    /**
     * Priority.
     */
    readonly priority: pulumi.Output<number>;
    /**
     * List of associated tags.
     */
    readonly tags: pulumi.Output<number[]>;
    /**
     * Use SSL flag.
     */
    readonly useSsl: pulumi.Output<boolean>;
    /**
     * Create a Freebox 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: FreeboxArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Freebox resources.
 */
export interface FreeboxState {
    /**
     * Add paused flag.
     */
    addPaused?: pulumi.Input<boolean>;
    /**
     * API URL.
     */
    apiUrl?: pulumi.Input<string>;
    /**
     * App ID.
     */
    appId?: pulumi.Input<string>;
    /**
     * App Token.
     */
    appToken?: pulumi.Input<string>;
    /**
     * List of categories.
     */
    categories?: pulumi.Input<pulumi.Input<inputs.DownloadClients.FreeboxCategory>[]>;
    /**
     * category.
     */
    category?: pulumi.Input<string>;
    /**
     * Movie directory.
     */
    destinationDirectory?: pulumi.Input<string>;
    /**
     * Enable flag.
     */
    enable?: pulumi.Input<boolean>;
    /**
     * host.
     */
    host?: pulumi.Input<string>;
    /**
     * Recent Movie priority. `0` Last, `1` First.
     */
    itemPriority?: pulumi.Input<number>;
    /**
     * Name of client category.
     */
    name?: pulumi.Input<string>;
    /**
     * Port.
     */
    port?: pulumi.Input<number>;
    /**
     * Priority.
     */
    priority?: pulumi.Input<number>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Use SSL flag.
     */
    useSsl?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a Freebox resource.
 */
export interface FreeboxArgs {
    /**
     * Add paused flag.
     */
    addPaused?: pulumi.Input<boolean>;
    /**
     * API URL.
     */
    apiUrl: pulumi.Input<string>;
    /**
     * App ID.
     */
    appId: pulumi.Input<string>;
    /**
     * App Token.
     */
    appToken: pulumi.Input<string>;
    /**
     * category.
     */
    category?: pulumi.Input<string>;
    /**
     * Movie directory.
     */
    destinationDirectory?: pulumi.Input<string>;
    /**
     * Enable flag.
     */
    enable?: pulumi.Input<boolean>;
    /**
     * host.
     */
    host: pulumi.Input<string>;
    /**
     * Recent Movie priority. `0` Last, `1` First.
     */
    itemPriority?: pulumi.Input<number>;
    /**
     * Name of client category.
     */
    name?: pulumi.Input<string>;
    /**
     * Port.
     */
    port: pulumi.Input<number>;
    /**
     * Priority.
     */
    priority?: pulumi.Input<number>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Use SSL flag.
     */
    useSsl?: pulumi.Input<boolean>;
}