@maienm/pulumi-readarr
Version:
A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0
178 lines (177 loc) • 4.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Profiles -->Metadata Profile resource.
* For more information refer to [Metadata Profile](https://wiki.servarr.com/readarr/settings#metadata-profiles) documentation.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as readarr from "@maienm/pulumi-readarr";
*
* const example = new readarr.metadata.Profile("example", {
* allowedLanguages: "eng,ita",
* ignoreds: [
* "alpha",
* "beta",
* ],
* minPages: 10,
* minPopularity: 3.5,
* skipMissingDate: false,
* skipMissingIsbn: true,
* skipPartsAndSets: false,
* skipSeriesSecondary: false,
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import readarr:Metadata/profile:Profile example 10
* ```
*/
export declare class Profile extends pulumi.CustomResource {
/**
* Get an existing Profile 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?: ProfileState, opts?: pulumi.CustomResourceOptions): Profile;
/**
* Returns true if the given object is an instance of Profile. 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 Profile;
/**
* Allowed languages. Comma separated list of ISO 639-3 language codes.
*/
readonly allowedLanguages: pulumi.Output<string>;
/**
* Terms to ignore.
*/
readonly ignoreds: pulumi.Output<string[]>;
/**
* Minimum pages.
*/
readonly minPages: pulumi.Output<number>;
/**
* Minimum popularity.
*/
readonly minPopularity: pulumi.Output<number>;
/**
* Metadata Profile name.
*/
readonly name: pulumi.Output<string>;
/**
* Skip missing date.
*/
readonly skipMissingDate: pulumi.Output<boolean>;
/**
* Skip missing ISBN.
*/
readonly skipMissingIsbn: pulumi.Output<boolean>;
/**
* Skip parts and sets.
*/
readonly skipPartsAndSets: pulumi.Output<boolean>;
/**
* Skip secondary series books.
*/
readonly skipSeriesSecondary: pulumi.Output<boolean>;
/**
* Create a Profile 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?: ProfileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Profile resources.
*/
export interface ProfileState {
/**
* Allowed languages. Comma separated list of ISO 639-3 language codes.
*/
allowedLanguages?: pulumi.Input<string>;
/**
* Terms to ignore.
*/
ignoreds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Minimum pages.
*/
minPages?: pulumi.Input<number>;
/**
* Minimum popularity.
*/
minPopularity?: pulumi.Input<number>;
/**
* Metadata Profile name.
*/
name?: pulumi.Input<string>;
/**
* Skip missing date.
*/
skipMissingDate?: pulumi.Input<boolean>;
/**
* Skip missing ISBN.
*/
skipMissingIsbn?: pulumi.Input<boolean>;
/**
* Skip parts and sets.
*/
skipPartsAndSets?: pulumi.Input<boolean>;
/**
* Skip secondary series books.
*/
skipSeriesSecondary?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a Profile resource.
*/
export interface ProfileArgs {
/**
* Allowed languages. Comma separated list of ISO 639-3 language codes.
*/
allowedLanguages?: pulumi.Input<string>;
/**
* Terms to ignore.
*/
ignoreds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Minimum pages.
*/
minPages?: pulumi.Input<number>;
/**
* Minimum popularity.
*/
minPopularity?: pulumi.Input<number>;
/**
* Metadata Profile name.
*/
name?: pulumi.Input<string>;
/**
* Skip missing date.
*/
skipMissingDate?: pulumi.Input<boolean>;
/**
* Skip missing ISBN.
*/
skipMissingIsbn?: pulumi.Input<boolean>;
/**
* Skip parts and sets.
*/
skipPartsAndSets?: pulumi.Input<boolean>;
/**
* Skip secondary series books.
*/
skipSeriesSecondary?: pulumi.Input<boolean>;
}