@maienm/pulumi-readarr/importlists/readarr.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * <!-- subcategory:Import Lists -->Import List Readarr resource.
 * For more information refer to [Import List](https://wiki.servarr.com/readarr/settings#import-lists) and [Readarr](https://wiki.servarr.com/readarr/supported#readarrimport).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as readarr from "@maienm/pulumi-readarr";
 *
 * const example = new readarr.importlists.Readarr("example", {
 *     apiKey: "APIKey",
 *     baseUrl: "http://127.0.0.1:8787",
 *     enableAutomaticAdd: false,
 *     metadataProfileId: 1,
 *     profileIds: [
 *         1,
 *         2,
 *     ],
 *     qualityProfileId: 1,
 *     rootFolderPath: "/books",
 *     shouldMonitor: "specificBook",
 *     shouldSearch: false,
 *     tagIds: [
 *         1,
 *         2,
 *         3,
 *     ],
 *     tags: [
 *         1,
 *         2,
 *         3,
 *     ],
 * });
 * ```
 *
 * ## Import
 *
 * import using the API/UI ID
 *
 * ```sh
 *  $ pulumi import readarr:ImportLists/readarr:Readarr example 1
 * ```
 */
export declare class Readarr extends pulumi.CustomResource {
    /**
     * Get an existing Readarr 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?: ReadarrState, opts?: pulumi.CustomResourceOptions): Readarr;
    /**
     * Returns true if the given object is an instance of Readarr.  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 Readarr;
    /**
     * API key.
     */
    readonly apiKey: pulumi.Output<string>;
    /**
     * Base URL.
     */
    readonly baseUrl: pulumi.Output<string>;
    /**
     * Enable automatic add flag.
     */
    readonly enableAutomaticAdd: pulumi.Output<boolean>;
    /**
     * List order.
     */
    readonly listOrder: pulumi.Output<number>;
    /**
     * Metadata profile ID.
     */
    readonly metadataProfileId: pulumi.Output<number>;
    /**
     * Monitor new items.
     */
    readonly monitorNewItems: pulumi.Output<string>;
    /**
     * Import List name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Profile IDs.
     */
    readonly profileIds: pulumi.Output<number[]>;
    /**
     * Quality profile ID.
     */
    readonly qualityProfileId: pulumi.Output<number>;
    /**
     * Root folder path.
     */
    readonly rootFolderPath: pulumi.Output<string>;
    /**
     * Should monitor.
     */
    readonly shouldMonitor: pulumi.Output<string>;
    /**
     * Should monitor existing flag.
     */
    readonly shouldMonitorExisting: pulumi.Output<boolean>;
    /**
     * Should search flag.
     */
    readonly shouldSearch: pulumi.Output<boolean>;
    /**
     * Tag IDs.
     */
    readonly tagIds: pulumi.Output<number[]>;
    /**
     * List of associated tags.
     */
    readonly tags: pulumi.Output<number[]>;
    /**
     * Create a Readarr 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: ReadarrArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Readarr resources.
 */
export interface ReadarrState {
    /**
     * API key.
     */
    apiKey?: pulumi.Input<string>;
    /**
     * Base URL.
     */
    baseUrl?: pulumi.Input<string>;
    /**
     * Enable automatic add flag.
     */
    enableAutomaticAdd?: pulumi.Input<boolean>;
    /**
     * List order.
     */
    listOrder?: pulumi.Input<number>;
    /**
     * Metadata profile ID.
     */
    metadataProfileId?: pulumi.Input<number>;
    /**
     * Monitor new items.
     */
    monitorNewItems?: pulumi.Input<string>;
    /**
     * Import List name.
     */
    name?: pulumi.Input<string>;
    /**
     * Profile IDs.
     */
    profileIds?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Quality profile ID.
     */
    qualityProfileId?: pulumi.Input<number>;
    /**
     * Root folder path.
     */
    rootFolderPath?: pulumi.Input<string>;
    /**
     * Should monitor.
     */
    shouldMonitor?: pulumi.Input<string>;
    /**
     * Should monitor existing flag.
     */
    shouldMonitorExisting?: pulumi.Input<boolean>;
    /**
     * Should search flag.
     */
    shouldSearch?: pulumi.Input<boolean>;
    /**
     * Tag IDs.
     */
    tagIds?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
}
/**
 * The set of arguments for constructing a Readarr resource.
 */
export interface ReadarrArgs {
    /**
     * API key.
     */
    apiKey: pulumi.Input<string>;
    /**
     * Base URL.
     */
    baseUrl: pulumi.Input<string>;
    /**
     * Enable automatic add flag.
     */
    enableAutomaticAdd?: pulumi.Input<boolean>;
    /**
     * List order.
     */
    listOrder?: pulumi.Input<number>;
    /**
     * Metadata profile ID.
     */
    metadataProfileId?: pulumi.Input<number>;
    /**
     * Monitor new items.
     */
    monitorNewItems?: pulumi.Input<string>;
    /**
     * Import List name.
     */
    name?: pulumi.Input<string>;
    /**
     * Profile IDs.
     */
    profileIds?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Quality profile ID.
     */
    qualityProfileId?: pulumi.Input<number>;
    /**
     * Root folder path.
     */
    rootFolderPath?: pulumi.Input<string>;
    /**
     * Should monitor.
     */
    shouldMonitor?: pulumi.Input<string>;
    /**
     * Should monitor existing flag.
     */
    shouldMonitorExisting?: pulumi.Input<boolean>;
    /**
     * Should search flag.
     */
    shouldSearch?: pulumi.Input<boolean>;
    /**
     * Tag IDs.
     */
    tagIds?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
}