@maienm/pulumi-lidarr
Version:
A Pulumi package for creating and managing Lidarr resources. Based on terraform-provider-lidarr: version v1.11.0
173 lines (172 loc) • 4.52 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Artists -->Artist resource.
* For more information refer to [Artists](https://wiki.servarr.com/lidarr/library#artists) documentation.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as lidarr from "@maienm/pulumi-lidarr";
*
* const example = new lidarr.artists.Artist("example", {
* artistName: "Queen",
* foreignArtistId: "0383dadf-2a4e-4d10-a46a-e9e041da8eb3",
* metadataProfileId: 1,
* monitored: true,
* path: "/music/Queen",
* qualityProfileId: 1,
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import lidarr:Artists/artist:Artist example 10
* ```
*/
export declare class Artist extends pulumi.CustomResource {
/**
* Get an existing Artist 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?: ArtistState, opts?: pulumi.CustomResourceOptions): Artist;
/**
* Returns true if the given object is an instance of Artist. 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 Artist;
/**
* Artist name.
*/
readonly artistName: pulumi.Output<string>;
/**
* Foreign artist ID.
*/
readonly foreignArtistId: pulumi.Output<string>;
/**
* List genres.
*/
readonly genres: pulumi.Output<string[]>;
/**
* Metadata profile ID.
*/
readonly metadataProfileId: pulumi.Output<number>;
/**
* Monitored flag.
*/
readonly monitored: pulumi.Output<boolean>;
/**
* Overview.
*/
readonly overview: pulumi.Output<string>;
/**
* Full artist path.
*/
readonly path: pulumi.Output<string>;
/**
* Quality profile ID.
*/
readonly qualityProfileId: pulumi.Output<number>;
/**
* Artist status.
*/
readonly status: pulumi.Output<string>;
/**
* List of associated tags.
*/
readonly tags: pulumi.Output<number[]>;
/**
* Create a Artist 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: ArtistArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Artist resources.
*/
export interface ArtistState {
/**
* Artist name.
*/
artistName?: pulumi.Input<string>;
/**
* Foreign artist ID.
*/
foreignArtistId?: pulumi.Input<string>;
/**
* List genres.
*/
genres?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Metadata profile ID.
*/
metadataProfileId?: pulumi.Input<number>;
/**
* Monitored flag.
*/
monitored?: pulumi.Input<boolean>;
/**
* Overview.
*/
overview?: pulumi.Input<string>;
/**
* Full artist path.
*/
path?: pulumi.Input<string>;
/**
* Quality profile ID.
*/
qualityProfileId?: pulumi.Input<number>;
/**
* Artist status.
*/
status?: pulumi.Input<string>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
}
/**
* The set of arguments for constructing a Artist resource.
*/
export interface ArtistArgs {
/**
* Artist name.
*/
artistName: pulumi.Input<string>;
/**
* Foreign artist ID.
*/
foreignArtistId: pulumi.Input<string>;
/**
* Metadata profile ID.
*/
metadataProfileId: pulumi.Input<number>;
/**
* Monitored flag.
*/
monitored: pulumi.Input<boolean>;
/**
* Full artist path.
*/
path: pulumi.Input<string>;
/**
* Quality profile ID.
*/
qualityProfileId: pulumi.Input<number>;
/**
* List of associated tags.
*/
tags?: pulumi.Input<pulumi.Input<number>[]>;
}