@maienm/pulumi-readarr
Version:
A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0
161 lines (160 loc) • 4.88 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* <!-- subcategory:Profiles -->Quality Profile resource.
* For more information refer to [Quality Profile](https://wiki.servarr.com/readarr/settings#quality-profiles) documentation.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as readarr from "@maienm/pulumi-readarr";
*
* const example = new readarr.profiles.QualityProfile("example", {
* cutoff: 1100,
* qualityGroups: [{
* id: 1100,
* name: "native",
* qualities: [
* {
* id: 3,
* name: "EPUB",
* },
* {
* id: 2,
* name: "MOBI",
* },
* ],
* }],
* upgradeAllowed: true,
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import readarr:Profiles/qualityProfile:QualityProfile example 10
* ```
*/
export declare class QualityProfile extends pulumi.CustomResource {
/**
* Get an existing QualityProfile 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?: QualityProfileState, opts?: pulumi.CustomResourceOptions): QualityProfile;
/**
* Returns true if the given object is an instance of QualityProfile. 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 QualityProfile;
/**
* Quality ID to which cutoff.
*/
readonly cutoff: pulumi.Output<number>;
/**
* Cutoff format score.
*/
readonly cutoffFormatScore: pulumi.Output<number>;
/**
* Format items. Only the ones with score > 0 are needed.
*/
readonly formatItems: pulumi.Output<outputs.Profiles.QualityProfileFormatItem[]>;
/**
* Min format score.
*/
readonly minFormatScore: pulumi.Output<number>;
/**
* Name.
*/
readonly name: pulumi.Output<string>;
/**
* Ordered list of allowed quality groups.
*/
readonly qualityGroups: pulumi.Output<outputs.Profiles.QualityProfileQualityGroup[]>;
/**
* Upgrade allowed flag.
*/
readonly upgradeAllowed: pulumi.Output<boolean>;
/**
* Create a QualityProfile 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: QualityProfileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering QualityProfile resources.
*/
export interface QualityProfileState {
/**
* Quality ID to which cutoff.
*/
cutoff?: pulumi.Input<number>;
/**
* Cutoff format score.
*/
cutoffFormatScore?: pulumi.Input<number>;
/**
* Format items. Only the ones with score > 0 are needed.
*/
formatItems?: pulumi.Input<pulumi.Input<inputs.Profiles.QualityProfileFormatItem>[]>;
/**
* Min format score.
*/
minFormatScore?: pulumi.Input<number>;
/**
* Name.
*/
name?: pulumi.Input<string>;
/**
* Ordered list of allowed quality groups.
*/
qualityGroups?: pulumi.Input<pulumi.Input<inputs.Profiles.QualityProfileQualityGroup>[]>;
/**
* Upgrade allowed flag.
*/
upgradeAllowed?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a QualityProfile resource.
*/
export interface QualityProfileArgs {
/**
* Quality ID to which cutoff.
*/
cutoff?: pulumi.Input<number>;
/**
* Cutoff format score.
*/
cutoffFormatScore?: pulumi.Input<number>;
/**
* Format items. Only the ones with score > 0 are needed.
*/
formatItems?: pulumi.Input<pulumi.Input<inputs.Profiles.QualityProfileFormatItem>[]>;
/**
* Min format score.
*/
minFormatScore?: pulumi.Input<number>;
/**
* Name.
*/
name?: pulumi.Input<string>;
/**
* Ordered list of allowed quality groups.
*/
qualityGroups: pulumi.Input<pulumi.Input<inputs.Profiles.QualityProfileQualityGroup>[]>;
/**
* Upgrade allowed flag.
*/
upgradeAllowed?: pulumi.Input<boolean>;
}