@maienm/pulumi-readarr
Version:
A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0
266 lines (265 loc) • 6.97 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Import Lists -->Import List Goodreads OwnedBooks resource.
* For more information refer to [Import List](https://wiki.servarr.com/readarr/settings#import-lists) and [Goodreads OwnedBooks](https://wiki.servarr.com/readarr/supported#goodreadsownedbooks).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as readarr from "@maienm/pulumi-readarr";
*
* const example = new readarr.importlists.GoodreadsOwnedBooks("example", {
* accessToken: "ExampleAccessToken",
* accessTokenSecret: "ExampleAccessTokenSecret",
* enableAutomaticAdd: false,
* metadataProfileId: 1,
* qualityProfileId: 1,
* rootFolderPath: "/books",
* shouldMonitor: "specificBook",
* shouldSearch: false,
* tags: [
* 1,
* 2,
* 3,
* ],
* userId: "163730408",
* username: "Test User",
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import readarr:ImportLists/goodreadsOwnedBooks:GoodreadsOwnedBooks example 1
* ```
*/
export declare class GoodreadsOwnedBooks extends pulumi.CustomResource {
/**
* Get an existing GoodreadsOwnedBooks 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?: GoodreadsOwnedBooksState, opts?: pulumi.CustomResourceOptions): GoodreadsOwnedBooks;
/**
* Returns true if the given object is an instance of GoodreadsOwnedBooks. 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 GoodreadsOwnedBooks;
/**
* Access token.
*/
readonly accessToken: pulumi.Output<string>;
/**
* Access token secret.
*/
readonly accessTokenSecret: pulumi.Output<string>;
/**
* Enable automatic add flag.
*/
readonly enableAutomaticAdd: pulumi.Output<boolean>;
/**
* List order.
*/
readonly listOrder: pulumi.Output<number>;
/**
* Metadata profile ID.
*/
readonly metadataProfileId: pulumi.Output<number>;
/**
* Monitor new items.
*/
readonly monitorNewItems: pulumi.Output<string>;
/**
* Import List name.
*/
readonly name: pulumi.Output<string>;
/**
* Quality profile ID.
*/
readonly qualityProfileId: pulumi.Output<number>;
/**
* Request token secret.
*/
readonly requestTokenSecret: pulumi.Output<string>;
/**
* Root folder path.
*/
readonly rootFolderPath: pulumi.Output<string>;
/**
* Should monitor.
*/
readonly shouldMonitor: pulumi.Output<string>;
/**
* Should monitor existing flag.
*/
readonly shouldMonitorExisting: pulumi.Output<boolean>;
/**
* Should search flag.
*/
readonly shouldSearch: pulumi.Output<boolean>;
/**
* List of associated tags.
*/
readonly tags: pulumi.Output<number[]>;
/**
* User ID.
*/
readonly userId: pulumi.Output<string>;
/**
* Username.
*/
readonly username: pulumi.Output<string>;
/**
* Create a GoodreadsOwnedBooks 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: GoodreadsOwnedBooksArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering GoodreadsOwnedBooks resources.
*/
export interface GoodreadsOwnedBooksState {
/**
* Access token.
*/
accessToken?: pulumi.Input<string>;
/**
* Access token secret.
*/
accessTokenSecret?: pulumi.Input<string>;
/**
* Enable automatic add flag.
*/
enableAutomaticAdd?: pulumi.Input<boolean>;
/**
* List order.
*/
listOrder?: pulumi.Input<number>;
/**
* Metadata profile ID.
*/
metadataProfileId?: pulumi.Input<number>;
/**
* Monitor new items.
*/
monitorNewItems?: pulumi.Input<string>;
/**
* Import List name.
*/
name?: pulumi.Input<string>;
/**
* Quality profile ID.
*/
qualityProfileId?: pulumi.Input<number>;
/**
* Request token secret.
*/
requestTokenSecret?: pulumi.Input<string>;
/**
* Root folder path.
*/
rootFolderPath?: pulumi.Input<string>;
/**
* Should monitor.
*/
shouldMonitor?: pulumi.Input<string>;
/**
* Should monitor existing flag.
*/
shouldMonitorExisting?: pulumi.Input<boolean>;
/**
* Should search flag.
*/
shouldSearch?: pulumi.Input<boolean>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* User ID.
*/
userId?: pulumi.Input<string>;
/**
* Username.
*/
username?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a GoodreadsOwnedBooks resource.
*/
export interface GoodreadsOwnedBooksArgs {
/**
* Access token.
*/
accessToken: pulumi.Input<string>;
/**
* Access token secret.
*/
accessTokenSecret: pulumi.Input<string>;
/**
* Enable automatic add flag.
*/
enableAutomaticAdd?: pulumi.Input<boolean>;
/**
* List order.
*/
listOrder?: pulumi.Input<number>;
/**
* Metadata profile ID.
*/
metadataProfileId?: pulumi.Input<number>;
/**
* Monitor new items.
*/
monitorNewItems?: pulumi.Input<string>;
/**
* Import List name.
*/
name?: pulumi.Input<string>;
/**
* Quality profile ID.
*/
qualityProfileId?: pulumi.Input<number>;
/**
* Request token secret.
*/
requestTokenSecret?: pulumi.Input<string>;
/**
* Root folder path.
*/
rootFolderPath?: pulumi.Input<string>;
/**
* Should monitor.
*/
shouldMonitor?: pulumi.Input<string>;
/**
* Should monitor existing flag.
*/
shouldMonitorExisting?: pulumi.Input<boolean>;
/**
* Should search flag.
*/
shouldSearch?: pulumi.Input<boolean>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
/**
* User ID.
*/
userId?: pulumi.Input<string>;
/**
* Username.
*/
username: pulumi.Input<string>;
}