@maienm/pulumi-readarr
Version:
A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0
145 lines (144 loc) • 3.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Authors -->Author resource.
* For more information refer to [Authors](https://wiki.servarr.com/readarr/library#authors) documentation.
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import readarr:Authors/author:Author example 10
* ```
*/
export declare class Author extends pulumi.CustomResource {
/**
* Get an existing Author 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?: AuthorState, opts?: pulumi.CustomResourceOptions): Author;
/**
* Returns true if the given object is an instance of Author. 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 Author;
/**
* Author name.
*/
readonly authorName: pulumi.Output<string>;
/**
* Foreign author ID.
*/
readonly foreignAuthorId: pulumi.Output<string>;
/**
* List genres.
*/
readonly genres: pulumi.Output<string[]>;
/**
* Monitored flag.
*/
readonly monitored: pulumi.Output<boolean>;
/**
* Overview.
*/
readonly overview: pulumi.Output<string>;
/**
* Full author path.
*/
readonly path: pulumi.Output<string>;
/**
* Quality profile ID.
*/
readonly qualityProfileId: pulumi.Output<number>;
/**
* Author status.
*/
readonly status: pulumi.Output<string>;
/**
* List of associated tags.
*/
readonly tags: pulumi.Output<number[]>;
/**
* Create a Author 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: AuthorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Author resources.
*/
export interface AuthorState {
/**
* Author name.
*/
authorName?: pulumi.Input<string>;
/**
* Foreign author ID.
*/
foreignAuthorId?: pulumi.Input<string>;
/**
* List genres.
*/
genres?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Monitored flag.
*/
monitored?: pulumi.Input<boolean>;
/**
* Overview.
*/
overview?: pulumi.Input<string>;
/**
* Full author path.
*/
path?: pulumi.Input<string>;
/**
* Quality profile ID.
*/
qualityProfileId?: pulumi.Input<number>;
/**
* Author status.
*/
status?: pulumi.Input<string>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
}
/**
* The set of arguments for constructing a Author resource.
*/
export interface AuthorArgs {
/**
* Author name.
*/
authorName: pulumi.Input<string>;
/**
* Foreign author ID.
*/
foreignAuthorId: pulumi.Input<string>;
/**
* Monitored flag.
*/
monitored: pulumi.Input<boolean>;
/**
* Full author path.
*/
path: pulumi.Input<string>;
/**
* Quality profile ID.
*/
qualityProfileId: pulumi.Input<number>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
}