@maienm/pulumi-readarr
Version:
A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0
109 lines (108 loc) • 3.79 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Media Management -->Naming resource.
* For more information refer to [Naming](https://wiki.servarr.com/readarr/settings#community-naming-suggestions) documentation.
*
* ## Import
*
* import does not need parameters
*
* ```sh
* $ pulumi import readarr: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;
/**
* Author folder format.
*/
readonly authorFolderFormat: pulumi.Output<string>;
/**
* Change how Readarr handles colon replacement. '0' Delete, '1' Dash, '2' Space Dash, '3' Space Dash Space, '4' Smart.
*/
readonly colonReplacementFormat: pulumi.Output<number>;
/**
* Readarr will use the existing file name if false.
*/
readonly renameBooks: pulumi.Output<boolean>;
/**
* Replace illegal characters. They will be removed if false.
*/
readonly replaceIllegalCharacters: pulumi.Output<boolean>;
/**
* Standard book formatss.
*/
readonly standardBookFormat: 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 {
/**
* Author folder format.
*/
authorFolderFormat?: pulumi.Input<string>;
/**
* Change how Readarr handles colon replacement. '0' Delete, '1' Dash, '2' Space Dash, '3' Space Dash Space, '4' Smart.
*/
colonReplacementFormat?: pulumi.Input<number>;
/**
* Readarr will use the existing file name if false.
*/
renameBooks?: pulumi.Input<boolean>;
/**
* Replace illegal characters. They will be removed if false.
*/
replaceIllegalCharacters?: pulumi.Input<boolean>;
/**
* Standard book formatss.
*/
standardBookFormat?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Naming resource.
*/
export interface NamingArgs {
/**
* Author folder format.
*/
authorFolderFormat: pulumi.Input<string>;
/**
* Change how Readarr handles colon replacement. '0' Delete, '1' Dash, '2' Space Dash, '3' Space Dash Space, '4' Smart.
*/
colonReplacementFormat: pulumi.Input<number>;
/**
* Readarr will use the existing file name if false.
*/
renameBooks: pulumi.Input<boolean>;
/**
* Replace illegal characters. They will be removed if false.
*/
replaceIllegalCharacters: pulumi.Input<boolean>;
/**
* Standard book formatss.
*/
standardBookFormat: pulumi.Input<string>;
}