@maienm/pulumi-readarr
Version:
A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0
195 lines (194 loc) • 5.19 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* <!-- subcategory:System -->Host resource.
* For more information refer to [Host](https://wiki.servarr.com/readarr/settings#general) documentation.
*
* ## Import
*
* import does not need parameters
*
* ```sh
* $ pulumi import readarr:System/host:Host example ""
* ```
*/
export declare class Host extends pulumi.CustomResource {
/**
* Get an existing Host 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?: HostState, opts?: pulumi.CustomResourceOptions): Host;
/**
* Returns true if the given object is an instance of Host. 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 Host;
/**
* Application URL.
*/
readonly applicationUrl: pulumi.Output<string>;
/**
* Authentication configuration.
*/
readonly authentication: pulumi.Output<outputs.System.HostAuthentication>;
/**
* Backup configuration.
*/
readonly backup: pulumi.Output<outputs.System.HostBackup>;
/**
* Bind address.
*/
readonly bindAddress: pulumi.Output<string>;
/**
* Instance name.
*/
readonly instanceName: pulumi.Output<string>;
/**
* Launch browser flag.
*/
readonly launchBrowser: pulumi.Output<boolean>;
/**
* Logging configuration.
*/
readonly logging: pulumi.Output<outputs.System.HostLogging>;
/**
* Proxy port.
*/
readonly port: pulumi.Output<number>;
/**
* Proxy configuration.
*/
readonly proxy: pulumi.Output<outputs.System.HostProxy>;
/**
* Backup configuration.
*/
readonly ssl: pulumi.Output<outputs.System.HostSsl>;
/**
* Update configuration.
*/
readonly update: pulumi.Output<outputs.System.HostUpdate>;
/**
* URL base.
*/
readonly urlBase: pulumi.Output<string>;
/**
* Create a Host 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: HostArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Host resources.
*/
export interface HostState {
/**
* Application URL.
*/
applicationUrl?: pulumi.Input<string>;
/**
* Authentication configuration.
*/
authentication?: pulumi.Input<inputs.System.HostAuthentication>;
/**
* Backup configuration.
*/
backup?: pulumi.Input<inputs.System.HostBackup>;
/**
* Bind address.
*/
bindAddress?: pulumi.Input<string>;
/**
* Instance name.
*/
instanceName?: pulumi.Input<string>;
/**
* Launch browser flag.
*/
launchBrowser?: pulumi.Input<boolean>;
/**
* Logging configuration.
*/
logging?: pulumi.Input<inputs.System.HostLogging>;
/**
* Proxy port.
*/
port?: pulumi.Input<number>;
/**
* Proxy configuration.
*/
proxy?: pulumi.Input<inputs.System.HostProxy>;
/**
* Backup configuration.
*/
ssl?: pulumi.Input<inputs.System.HostSsl>;
/**
* Update configuration.
*/
update?: pulumi.Input<inputs.System.HostUpdate>;
/**
* URL base.
*/
urlBase?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Host resource.
*/
export interface HostArgs {
/**
* Application URL.
*/
applicationUrl: pulumi.Input<string>;
/**
* Authentication configuration.
*/
authentication: pulumi.Input<inputs.System.HostAuthentication>;
/**
* Backup configuration.
*/
backup: pulumi.Input<inputs.System.HostBackup>;
/**
* Bind address.
*/
bindAddress: pulumi.Input<string>;
/**
* Instance name.
*/
instanceName: pulumi.Input<string>;
/**
* Launch browser flag.
*/
launchBrowser?: pulumi.Input<boolean>;
/**
* Logging configuration.
*/
logging: pulumi.Input<inputs.System.HostLogging>;
/**
* Proxy port.
*/
port: pulumi.Input<number>;
/**
* Proxy configuration.
*/
proxy: pulumi.Input<inputs.System.HostProxy>;
/**
* Backup configuration.
*/
ssl: pulumi.Input<inputs.System.HostSsl>;
/**
* Update configuration.
*/
update: pulumi.Input<inputs.System.HostUpdate>;
/**
* URL base.
*/
urlBase: pulumi.Input<string>;
}