@maienm/pulumi-readarr/downloadclients/aria2.d.ts

A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0

import * as pulumi from "@pulumi/pulumi";
/**
 * <!-- subcategory:Download Clients -->Download Client Aria2 resource.
 * For more information refer to [Download Client](https://wiki.servarr.com/readarr/settings#download-clients) and [Aria2](https://wiki.servarr.com/readarr/supported#aria2).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as readarr from "@maienm/pulumi-readarr";
 *
 * const example = new readarr.downloadclients.Aria2("example", {
 *     enable: true,
 *     host: "aria2",
 *     port: 6800,
 *     priority: 1,
 *     rpcPath: "/aria2/",
 * });
 * ```
 *
 * ## Import
 *
 * import using the API/UI ID
 *
 * ```sh
 *  $ pulumi import readarr:DownloadClients/aria2:Aria2 example 1
 * ```
 */
export declare class Aria2 extends pulumi.CustomResource {
    /**
     * Get an existing Aria2 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?: Aria2State, opts?: pulumi.CustomResourceOptions): Aria2;
    /**
     * Returns true if the given object is an instance of Aria2.  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 Aria2;
    /**
     * Enable flag.
     */
    readonly enable: pulumi.Output<boolean>;
    /**
     * host.
     */
    readonly host: pulumi.Output<string>;
    /**
     * Download Client name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Port.
     */
    readonly port: pulumi.Output<number>;
    /**
     * Priority.
     */
    readonly priority: pulumi.Output<number>;
    /**
     * Remove completed downloads flag.
     */
    readonly removeCompletedDownloads: pulumi.Output<boolean>;
    /**
     * Remove failed downloads flag.
     */
    readonly removeFailedDownloads: pulumi.Output<boolean>;
    /**
     * RPC path.
     */
    readonly rpcPath: pulumi.Output<string>;
    /**
     * Secret token.
     */
    readonly secretToken: pulumi.Output<string>;
    /**
     * List of associated tags.
     */
    readonly tags: pulumi.Output<number[]>;
    /**
     * Use SSL flag.
     */
    readonly useSsl: pulumi.Output<boolean>;
    /**
     * Create a Aria2 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?: Aria2Args, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Aria2 resources.
 */
export interface Aria2State {
    /**
     * Enable flag.
     */
    enable?: pulumi.Input<boolean>;
    /**
     * host.
     */
    host?: pulumi.Input<string>;
    /**
     * Download Client name.
     */
    name?: pulumi.Input<string>;
    /**
     * Port.
     */
    port?: pulumi.Input<number>;
    /**
     * Priority.
     */
    priority?: pulumi.Input<number>;
    /**
     * Remove completed downloads flag.
     */
    removeCompletedDownloads?: pulumi.Input<boolean>;
    /**
     * Remove failed downloads flag.
     */
    removeFailedDownloads?: pulumi.Input<boolean>;
    /**
     * RPC path.
     */
    rpcPath?: pulumi.Input<string>;
    /**
     * Secret token.
     */
    secretToken?: pulumi.Input<string>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Use SSL flag.
     */
    useSsl?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a Aria2 resource.
 */
export interface Aria2Args {
    /**
     * Enable flag.
     */
    enable?: pulumi.Input<boolean>;
    /**
     * host.
     */
    host?: pulumi.Input<string>;
    /**
     * Download Client name.
     */
    name?: pulumi.Input<string>;
    /**
     * Port.
     */
    port?: pulumi.Input<number>;
    /**
     * Priority.
     */
    priority?: pulumi.Input<number>;
    /**
     * Remove completed downloads flag.
     */
    removeCompletedDownloads?: pulumi.Input<boolean>;
    /**
     * Remove failed downloads flag.
     */
    removeFailedDownloads?: pulumi.Input<boolean>;
    /**
     * RPC path.
     */
    rpcPath?: pulumi.Input<string>;
    /**
     * Secret token.
     */
    secretToken?: pulumi.Input<string>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Use SSL flag.
     */
    useSsl?: pulumi.Input<boolean>;
}