UNPKG

@maienm/pulumi-readarr

Version:

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

98 lines (97 loc) 3.14 kB
import * as pulumi from "@pulumi/pulumi"; /** * <!-- subcategory:Download Clients -->Remote Path Mapping resource. * For more information refer to [Remote Path Mapping](https://wiki.servarr.com/readarr/settings#remote-path-mappings) documentation. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as readarr from "@maienm/pulumi-readarr"; * * const example = new readarr.downloadclients.RemotePathMapping("example", { * host: "www.transmission.com", * localPath: "/transmission-download/", * remotePath: "/download/", * }); * ``` * * ## Import * * import using the API/UI ID * * ```sh * $ pulumi import readarr:DownloadClients/remotePathMapping:RemotePathMapping example 10 * ``` */ export declare class RemotePathMapping extends pulumi.CustomResource { /** * Get an existing RemotePathMapping 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?: RemotePathMappingState, opts?: pulumi.CustomResourceOptions): RemotePathMapping; /** * Returns true if the given object is an instance of RemotePathMapping. 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 RemotePathMapping; /** * Download Client host. */ readonly host: pulumi.Output<string>; /** * Local path. */ readonly localPath: pulumi.Output<string>; /** * Download Client remote path. */ readonly remotePath: pulumi.Output<string>; /** * Create a RemotePathMapping 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: RemotePathMappingArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering RemotePathMapping resources. */ export interface RemotePathMappingState { /** * Download Client host. */ host?: pulumi.Input<string>; /** * Local path. */ localPath?: pulumi.Input<string>; /** * Download Client remote path. */ remotePath?: pulumi.Input<string>; } /** * The set of arguments for constructing a RemotePathMapping resource. */ export interface RemotePathMappingArgs { /** * Download Client host. */ host: pulumi.Input<string>; /** * Local path. */ localPath: pulumi.Input<string>; /** * Download Client remote path. */ remotePath: pulumi.Input<string>; }