@maienm/pulumi-lidarr/mediamanagement/naming.d.ts

A Pulumi package for creating and managing Lidarr resources. Based on terraform-provider-lidarr: version v1.11.0

import * as pulumi from "@pulumi/pulumi";
/**
 * <!-- subcategory:Media Management -->Naming resource.
 * For more information refer to [Naming](https://wiki.servarr.com/lidarr/settings#community-naming-suggestions) documentation.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as lidarr from "@maienm/pulumi-lidarr";
 *
 * const example = new lidarr.mediamanagement.Naming("example", {
 *     artistFolderFormat: "{Artist Name}",
 *     multiDiscTrackFormat: "{Album Title} ({Release Year})/{Medium Format} {medium:00}/{Artist Name} - {Album Title} - {track:00} - {Track Title}",
 *     renameTracks: true,
 *     replaceIllegalCharacters: true,
 *     standardTrackFormat: "{Album Title} ({Release Year})/{Artist Name} - {Album Title} - {track:00} - {Track Title}",
 * });
 * ```
 *
 * ## Import
 *
 * import
 *
 * ```sh
 *  $ pulumi import lidarr:MediaManagement/naming:Naming example
 * ```
 */
export declare class Naming extends pulumi.CustomResource {
    /**
     * Get an existing Naming 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?: NamingState, opts?: pulumi.CustomResourceOptions): Naming;
    /**
     * Returns true if the given object is an instance of Naming.  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 Naming;
    /**
     * Artist folder format.
     */
    readonly artistFolderFormat: pulumi.Output<string>;
    /**
     * Multi disc track format.
     */
    readonly multiDiscTrackFormat: pulumi.Output<string>;
    /**
     * Lidarr will use the existing file name if false.
     */
    readonly renameTracks: pulumi.Output<boolean>;
    /**
     * Replace illegal characters. They will be removed if false.
     */
    readonly replaceIllegalCharacters: pulumi.Output<boolean>;
    /**
     * Standard track formatss.
     */
    readonly standardTrackFormat: pulumi.Output<string>;
    /**
     * Create a Naming 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: NamingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Naming resources.
 */
export interface NamingState {
    /**
     * Artist folder format.
     */
    artistFolderFormat?: pulumi.Input<string>;
    /**
     * Multi disc track format.
     */
    multiDiscTrackFormat?: pulumi.Input<string>;
    /**
     * Lidarr will use the existing file name if false.
     */
    renameTracks?: pulumi.Input<boolean>;
    /**
     * Replace illegal characters. They will be removed if false.
     */
    replaceIllegalCharacters?: pulumi.Input<boolean>;
    /**
     * Standard track formatss.
     */
    standardTrackFormat?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Naming resource.
 */
export interface NamingArgs {
    /**
     * Artist folder format.
     */
    artistFolderFormat: pulumi.Input<string>;
    /**
     * Multi disc track format.
     */
    multiDiscTrackFormat: pulumi.Input<string>;
    /**
     * Lidarr will use the existing file name if false.
     */
    renameTracks: pulumi.Input<boolean>;
    /**
     * Replace illegal characters. They will be removed if false.
     */
    replaceIllegalCharacters: pulumi.Input<boolean>;
    /**
     * Standard track formatss.
     */
    standardTrackFormat: pulumi.Input<string>;
}