@maienm/pulumi-prowlarr/indexers/indexer.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * <!-- subcategory:Indexers -->Generic Indexer resource.
 * For more information refer to [Indexer](https://wiki.servarr.com/prowlarr/indexers) documentation.
 *
 * ## Import
 *
 * import using the API/UI ID
 *
 * ```sh
 *  $ pulumi import prowlarr:Indexers/indexer:Indexer example 1
 * ```
 */
export declare class Indexer extends pulumi.CustomResource {
    /**
     * Get an existing Indexer 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?: IndexerState, opts?: pulumi.CustomResourceOptions): Indexer;
    /**
     * Returns true if the given object is an instance of Indexer.  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 Indexer;
    /**
     * Application profile ID.
     */
    readonly appProfileId: pulumi.Output<number>;
    /**
     * Indexer configuration template.
     */
    readonly configContract: pulumi.Output<string>;
    /**
     * Enable flag.
     */
    readonly enable: pulumi.Output<boolean>;
    /**
     * Set of configuration fields. All non-empty fields must be specified.
     */
    readonly fields: pulumi.Output<outputs.Indexers.IndexerField[]>;
    /**
     * Indexer implementation name.
     */
    readonly implementation: pulumi.Output<string>;
    /**
     * Language.
     */
    readonly language: pulumi.Output<string>;
    /**
     * Field name.
     * It must contain the whole field name comprehensive of its prefix (e.g. `baseSettings.`).
     */
    readonly name: pulumi.Output<string>;
    /**
     * Priority.
     */
    readonly priority: pulumi.Output<number>;
    /**
     * Privacy.
     */
    readonly privacy: pulumi.Output<string>;
    /**
     * Protocol. Valid values are 'usenet' and 'torrent'.
     */
    readonly protocol: pulumi.Output<string>;
    /**
     * List of associated tags.
     */
    readonly tags: pulumi.Output<number[]>;
    /**
     * Create a Indexer 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: IndexerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Indexer resources.
 */
export interface IndexerState {
    /**
     * Application profile ID.
     */
    appProfileId?: pulumi.Input<number>;
    /**
     * Indexer configuration template.
     */
    configContract?: pulumi.Input<string>;
    /**
     * Enable flag.
     */
    enable?: pulumi.Input<boolean>;
    /**
     * Set of configuration fields. All non-empty fields must be specified.
     */
    fields?: pulumi.Input<pulumi.Input<inputs.Indexers.IndexerField>[]>;
    /**
     * Indexer implementation name.
     */
    implementation?: pulumi.Input<string>;
    /**
     * Language.
     */
    language?: pulumi.Input<string>;
    /**
     * Field name.
     * It must contain the whole field name comprehensive of its prefix (e.g. `baseSettings.`).
     */
    name?: pulumi.Input<string>;
    /**
     * Priority.
     */
    priority?: pulumi.Input<number>;
    /**
     * Privacy.
     */
    privacy?: pulumi.Input<string>;
    /**
     * Protocol. Valid values are 'usenet' and 'torrent'.
     */
    protocol?: pulumi.Input<string>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
}
/**
 * The set of arguments for constructing a Indexer resource.
 */
export interface IndexerArgs {
    /**
     * Application profile ID.
     */
    appProfileId: pulumi.Input<number>;
    /**
     * Indexer configuration template.
     */
    configContract: pulumi.Input<string>;
    /**
     * Enable flag.
     */
    enable?: pulumi.Input<boolean>;
    /**
     * Set of configuration fields. All non-empty fields must be specified.
     */
    fields: pulumi.Input<pulumi.Input<inputs.Indexers.IndexerField>[]>;
    /**
     * Indexer implementation name.
     */
    implementation: pulumi.Input<string>;
    /**
     * Field name.
     * It must contain the whole field name comprehensive of its prefix (e.g. `baseSettings.`).
     */
    name?: pulumi.Input<string>;
    /**
     * Priority.
     */
    priority?: pulumi.Input<number>;
    /**
     * Protocol. Valid values are 'usenet' and 'torrent'.
     */
    protocol: pulumi.Input<string>;
    /**
     * List of associated tags.
     */
    tags?: pulumi.Input<pulumi.Input<number>[]>;
}