@maienm/pulumi-readarr/profiles/customFormat.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";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * <!-- subcategory:Profiles -->Custom Format resource.
 * For more information refer to [Custom Format](https://wiki.servarr.com/readarr/settings#custom-formats).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as readarr from "@maienm/pulumi-readarr";
 *
 * const example = new readarr.profiles.CustomFormat("example", {
 *     includeCustomFormatWhenRenaming: true,
 *     specifications: [
 *         {
 *             implementation: "ReleaseTitleSpecification",
 *             name: "Preferred Words",
 *             negate: false,
 *             required: false,
 *             value: "\\b(SPARKS|Framestor)\\b",
 *         },
 *         {
 *             implementation: "SizeSpecification",
 *             max: 100,
 *             min: 0,
 *             name: "Size",
 *             negate: false,
 *             required: false,
 *         },
 *     ],
 * });
 * ```
 *
 * ## Import
 *
 * import using the API/UI ID
 *
 * ```sh
 *  $ pulumi import readarr:Profiles/customFormat:CustomFormat example 1
 * ```
 */
export declare class CustomFormat extends pulumi.CustomResource {
    /**
     * Get an existing CustomFormat 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?: CustomFormatState, opts?: pulumi.CustomResourceOptions): CustomFormat;
    /**
     * Returns true if the given object is an instance of CustomFormat.  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 CustomFormat;
    /**
     * Include custom format when renaming flag.
     */
    readonly includeCustomFormatWhenRenaming: pulumi.Output<boolean>;
    /**
     * Specification name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Specifications.
     */
    readonly specifications: pulumi.Output<outputs.Profiles.CustomFormatSpecification[]>;
    /**
     * Create a CustomFormat 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: CustomFormatArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering CustomFormat resources.
 */
export interface CustomFormatState {
    /**
     * Include custom format when renaming flag.
     */
    includeCustomFormatWhenRenaming?: pulumi.Input<boolean>;
    /**
     * Specification name.
     */
    name?: pulumi.Input<string>;
    /**
     * Specifications.
     */
    specifications?: pulumi.Input<pulumi.Input<inputs.Profiles.CustomFormatSpecification>[]>;
}
/**
 * The set of arguments for constructing a CustomFormat resource.
 */
export interface CustomFormatArgs {
    /**
     * Include custom format when renaming flag.
     */
    includeCustomFormatWhenRenaming?: pulumi.Input<boolean>;
    /**
     * Specification name.
     */
    name?: pulumi.Input<string>;
    /**
     * Specifications.
     */
    specifications: pulumi.Input<pulumi.Input<inputs.Profiles.CustomFormatSpecification>[]>;
}