UNPKG

@maienm/pulumi-prowlarr

Version:

A Pulumi package for creating and managing Prowlarr resources. Based on terraform-provider-prowlarr: version v2.3.0

135 lines (134 loc) 3.59 kB
import * as pulumi from "@pulumi/pulumi"; /** * <!-- subcategory:Indexer Proxies -->Indexer Proxy Socks5 resource. * For more information refer to [Indexer Proxy](https://wiki.servarr.com/prowlarr/settings#indexer-proxies) and [Socks5](https://wiki.servarr.com/prowlarr/supported#socks5). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as prowlarr from "@maienm/pulumi-prowlarr"; * * const example = new prowlarr.indexerproxies.Socks5("example", { * host: "localhost", * password: "Pass", * port: 8080, * username: "User", * }); * ``` * * ## Import * * import using the API/UI ID * * ```sh * $ pulumi import prowlarr:IndexerProxies/socks5:Socks5 example 1 * ``` */ export declare class Socks5 extends pulumi.CustomResource { /** * Get an existing Socks5 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?: Socks5State, opts?: pulumi.CustomResourceOptions): Socks5; /** * Returns true if the given object is an instance of Socks5. 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 Socks5; /** * host. */ readonly host: pulumi.Output<string>; /** * Indexer Proxy name. */ readonly name: pulumi.Output<string>; /** * Password. */ readonly password: pulumi.Output<string>; /** * Port. */ readonly port: pulumi.Output<number>; /** * List of associated tags. */ readonly tags: pulumi.Output<number[]>; /** * Username. */ readonly username: pulumi.Output<string>; /** * Create a Socks5 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: Socks5Args, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Socks5 resources. */ export interface Socks5State { /** * host. */ host?: pulumi.Input<string>; /** * Indexer Proxy name. */ name?: pulumi.Input<string>; /** * Password. */ password?: pulumi.Input<string>; /** * Port. */ port?: pulumi.Input<number>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; /** * Username. */ username?: pulumi.Input<string>; } /** * The set of arguments for constructing a Socks5 resource. */ export interface Socks5Args { /** * host. */ host: pulumi.Input<string>; /** * Indexer Proxy name. */ name?: pulumi.Input<string>; /** * Password. */ password: pulumi.Input<string>; /** * Port. */ port: pulumi.Input<number>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; /** * Username. */ username: pulumi.Input<string>; }