@maienm/pulumi-readarr
Version:
A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0
124 lines (123 loc) • 3.53 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Metadata -->Metadata Config resource.
* For more information refer to [Metadata](https://wiki.servarr.com/readarr/settings#options) documentation.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as readarr from "@maienm/pulumi-readarr";
*
* const example = new readarr.metadata.Config("example", {
* embedMetadata: true,
* scrubAudioTags: false,
* updateCovers: true,
* writeAudioTags: "no",
* writeBookTags: "newFiles",
* });
* ```
*
* ## Import
*
* import does not need parameters
*
* ```sh
* $ pulumi import readarr:Metadata/config:Config example ""
* ```
*/
export declare class Config extends pulumi.CustomResource {
/**
* Get an existing Config 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?: ConfigState, opts?: pulumi.CustomResourceOptions): Config;
/**
* Returns true if the given object is an instance of Config. 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 Config;
/**
* Embed metadata in book files.
*/
readonly embedMetadata: pulumi.Output<boolean>;
/**
* Scrub audio tags.
*/
readonly scrubAudioTags: pulumi.Output<boolean>;
/**
* Update covers.
*/
readonly updateCovers: pulumi.Output<boolean>;
/**
* Write audio tags.
*/
readonly writeAudioTags: pulumi.Output<string>;
/**
* Write book tags.
*/
readonly writeBookTags: pulumi.Output<string>;
/**
* Create a Config 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: ConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Config resources.
*/
export interface ConfigState {
/**
* Embed metadata in book files.
*/
embedMetadata?: pulumi.Input<boolean>;
/**
* Scrub audio tags.
*/
scrubAudioTags?: pulumi.Input<boolean>;
/**
* Update covers.
*/
updateCovers?: pulumi.Input<boolean>;
/**
* Write audio tags.
*/
writeAudioTags?: pulumi.Input<string>;
/**
* Write book tags.
*/
writeBookTags?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Config resource.
*/
export interface ConfigArgs {
/**
* Embed metadata in book files.
*/
embedMetadata: pulumi.Input<boolean>;
/**
* Scrub audio tags.
*/
scrubAudioTags: pulumi.Input<boolean>;
/**
* Update covers.
*/
updateCovers: pulumi.Input<boolean>;
/**
* Write audio tags.
*/
writeAudioTags: pulumi.Input<string>;
/**
* Write book tags.
*/
writeBookTags: pulumi.Input<string>;
}