@maienm/pulumi-lidarr
Version:
A Pulumi package for creating and managing Lidarr resources. Based on terraform-provider-lidarr: version v1.11.0
157 lines (156 loc) • 4.37 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Media Management -->Root Folder resource.
* For more information refer to [Root Folders](https://wiki.servarr.com/lidarr/settings#root-folders) documentation.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as lidarr from "@maienm/pulumi-lidarr";
*
* const example = new lidarr.mediamanagement.RootFolder("example", {
* metadataProfileId: 1,
* monitorOption: "future",
* newItemMonitorOption: "all",
* path: "/music",
* qualityProfileId: 1,
* tags: [1],
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import lidarr:MediaManagement/rootFolder:RootFolder example 10
* ```
*/
export declare class RootFolder extends pulumi.CustomResource {
/**
* Get an existing RootFolder 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?: RootFolderState, opts?: pulumi.CustomResourceOptions): RootFolder;
/**
* Returns true if the given object is an instance of RootFolder. 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 RootFolder;
/**
* Access flag.
*/
readonly accessible: pulumi.Output<boolean>;
/**
* Metadata profile ID.
*/
readonly metadataProfileId: pulumi.Output<number>;
/**
* Monitor option.
*/
readonly monitorOption: pulumi.Output<string>;
/**
* Root Folder friendly name.
*/
readonly name: pulumi.Output<string>;
/**
* New item monitor option.
*/
readonly newItemMonitorOption: pulumi.Output<string>;
/**
* Root Folder absolute path.
*/
readonly path: pulumi.Output<string>;
/**
* Quality profile ID.
*/
readonly qualityProfileId: pulumi.Output<number>;
/**
* List of associated tags.
*/
readonly tags: pulumi.Output<number[]>;
/**
* Create a RootFolder 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: RootFolderArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RootFolder resources.
*/
export interface RootFolderState {
/**
* Access flag.
*/
accessible?: pulumi.Input<boolean>;
/**
* Metadata profile ID.
*/
metadataProfileId?: pulumi.Input<number>;
/**
* Monitor option.
*/
monitorOption?: pulumi.Input<string>;
/**
* Root Folder friendly name.
*/
name?: pulumi.Input<string>;
/**
* New item monitor option.
*/
newItemMonitorOption?: pulumi.Input<string>;
/**
* Root Folder absolute path.
*/
path?: pulumi.Input<string>;
/**
* Quality profile ID.
*/
qualityProfileId?: pulumi.Input<number>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
}
/**
* The set of arguments for constructing a RootFolder resource.
*/
export interface RootFolderArgs {
/**
* Metadata profile ID.
*/
metadataProfileId: pulumi.Input<number>;
/**
* Monitor option.
*/
monitorOption: pulumi.Input<string>;
/**
* Root Folder friendly name.
*/
name?: pulumi.Input<string>;
/**
* New item monitor option.
*/
newItemMonitorOption: pulumi.Input<string>;
/**
* Root Folder absolute path.
*/
path: pulumi.Input<string>;
/**
* Quality profile ID.
*/
qualityProfileId: pulumi.Input<number>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
}