@maienm/pulumi-prowlarr
Version:
A Pulumi package for creating and managing Prowlarr resources. Based on terraform-provider-prowlarr: version v2.3.0
123 lines (122 loc) • 3.63 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* <!-- subcategory:Applications -->Sync Profile resource.
* For more information refer to [Sync Profiles](https://wiki.servarr.com/prowlarr/settings#sync-profiles) documentation.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as prowlarr from "@maienm/pulumi-prowlarr";
*
* const example = new prowlarr.applications.SyncProfile("example", {
* enableAutomaticSearch: true,
* enableInteractiveSearch: true,
* enableRss: true,
* minimumSeeders: 1,
* });
* ```
*
* ## Import
*
* import using the API/UI ID
*
* ```sh
* $ pulumi import prowlarr:Applications/syncProfile:SyncProfile example 1
* ```
*/
export declare class SyncProfile extends pulumi.CustomResource {
/**
* Get an existing SyncProfile 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?: SyncProfileState, opts?: pulumi.CustomResourceOptions): SyncProfile;
/**
* Returns true if the given object is an instance of SyncProfile. 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 SyncProfile;
/**
* Enable automatic search flag.
*/
readonly enableAutomaticSearch: pulumi.Output<boolean>;
/**
* Enable interactive search flag.
*/
readonly enableInteractiveSearch: pulumi.Output<boolean>;
/**
* Enable RSS flag.
*/
readonly enableRss: pulumi.Output<boolean>;
/**
* Minimum seeders.
*/
readonly minimumSeeders: pulumi.Output<number>;
/**
* Name.
*/
readonly name: pulumi.Output<string>;
/**
* Create a SyncProfile 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: SyncProfileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SyncProfile resources.
*/
export interface SyncProfileState {
/**
* Enable automatic search flag.
*/
enableAutomaticSearch?: pulumi.Input<boolean>;
/**
* Enable interactive search flag.
*/
enableInteractiveSearch?: pulumi.Input<boolean>;
/**
* Enable RSS flag.
*/
enableRss?: pulumi.Input<boolean>;
/**
* Minimum seeders.
*/
minimumSeeders?: pulumi.Input<number>;
/**
* Name.
*/
name?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SyncProfile resource.
*/
export interface SyncProfileArgs {
/**
* Enable automatic search flag.
*/
enableAutomaticSearch: pulumi.Input<boolean>;
/**
* Enable interactive search flag.
*/
enableInteractiveSearch: pulumi.Input<boolean>;
/**
* Enable RSS flag.
*/
enableRss: pulumi.Input<boolean>;
/**
* Minimum seeders.
*/
minimumSeeders: pulumi.Input<number>;
/**
* Name.
*/
name?: pulumi.Input<string>;
}