@maienm/pulumi-lidarr
Version:
A Pulumi package for creating and managing Lidarr resources. Based on terraform-provider-lidarr: version v1.11.0
159 lines (158 loc) • 4.53 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Download Clients -->Download Client Usenet Blackhole resource.
* For more information refer to [Download Client](https://wiki.servarr.com/lidarr/settings#download-clients) and [UsenetBlackhole](https://wiki.servarr.com/lidarr/supported#usenetblackhole).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as lidarr from "@maienm/pulumi-lidarr";
*
* const example = new lidarr.downloadclients.UsenetBlackhole("example", {
* enable: true,
* nzbFolder: "/nzb/",
* priority: 1,
* watchFolder: "/watch/",
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import lidarr:DownloadClients/usenetBlackhole:UsenetBlackhole example 1
* ```
*/
export declare class UsenetBlackhole extends pulumi.CustomResource {
/**
* Get an existing UsenetBlackhole 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?: UsenetBlackholeState, opts?: pulumi.CustomResourceOptions): UsenetBlackhole;
/**
* Returns true if the given object is an instance of UsenetBlackhole. 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 UsenetBlackhole;
/**
* Enable flag.
*/
readonly enable: pulumi.Output<boolean>;
/**
* Download Client name.
*/
readonly name: pulumi.Output<string>;
/**
* Usenet folder.
*/
readonly nzbFolder: pulumi.Output<string>;
/**
* Priority.
*/
readonly priority: pulumi.Output<number>;
/**
* Remove completed downloads flag.
*/
readonly removeCompletedDownloads: pulumi.Output<boolean>;
/**
* Remove failed downloads flag.
*/
readonly removeFailedDownloads: pulumi.Output<boolean>;
/**
* List of associated tags.
*/
readonly tags: pulumi.Output<number[]>;
/**
* Watch folder flag.
*/
readonly watchFolder: pulumi.Output<string>;
/**
* Create a UsenetBlackhole 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: UsenetBlackholeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering UsenetBlackhole resources.
*/
export interface UsenetBlackholeState {
/**
* Enable flag.
*/
enable?: pulumi.Input<boolean>;
/**
* Download Client name.
*/
name?: pulumi.Input<string>;
/**
* Usenet folder.
*/
nzbFolder?: pulumi.Input<string>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Remove completed downloads flag.
*/
removeCompletedDownloads?: pulumi.Input<boolean>;
/**
* Remove failed downloads flag.
*/
removeFailedDownloads?: pulumi.Input<boolean>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Watch folder flag.
*/
watchFolder?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a UsenetBlackhole resource.
*/
export interface UsenetBlackholeArgs {
/**
* Enable flag.
*/
enable?: pulumi.Input<boolean>;
/**
* Download Client name.
*/
name?: pulumi.Input<string>;
/**
* Usenet folder.
*/
nzbFolder: pulumi.Input<string>;
/**
* Priority.
*/
priority?: pulumi.Input<number>;
/**
* Remove completed downloads flag.
*/
removeCompletedDownloads?: pulumi.Input<boolean>;
/**
* Remove failed downloads flag.
*/
removeFailedDownloads?: pulumi.Input<boolean>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* Watch folder flag.
*/
watchFolder: pulumi.Input<string>;
}