@pulumiverse/harbor
Version:
A Pulumi package for creating and managing Harbor resources.
184 lines (183 loc) • 6.69 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ### Basic Usage
*
* ### Usage with Authentication
*
* ## Import
*
* The `harbor_preheat_instance` resource can be imported using the preheat instance ID.
*
* ```sh
* $ pulumi import harbor:index/preheatInstance:PreheatInstance example /p2p/preheat/instances/example-preheat-instance
* ```
*/
export declare class PreheatInstance extends pulumi.CustomResource {
/**
* Get an existing PreheatInstance 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?: PreheatInstanceState, opts?: pulumi.CustomResourceOptions): PreheatInstance;
/**
* Returns true if the given object is an instance of PreheatInstance. 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 PreheatInstance;
/**
* The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
*/
readonly authMode: pulumi.Output<string | undefined>;
/**
* Whether the preheat instance is the default instance. Defaults to false.
*/
readonly default: pulumi.Output<boolean | undefined>;
/**
* The description of the preheat instance. Defaults to an empty string.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Whether the preheat instance is enabled. Defaults to true.
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* The endpoint of the preheat instance.
*/
readonly endpoint: pulumi.Output<string>;
/**
* Whether to allow insecure connections to the preheat instance. Defaults to false.
*/
readonly insecure: pulumi.Output<boolean | undefined>;
/**
* The name of the preheat instance.
*/
readonly name: pulumi.Output<string>;
/**
* The password for the preheat instance. Required if `authMode` is "BASIC". Defaults to an empty string.
*/
readonly password: pulumi.Output<string | undefined>;
/**
* The token for the preheat instance. Required if `authMode` is "OAUTH". Defaults to an empty string.
*/
readonly token: pulumi.Output<string | undefined>;
/**
* The username for the preheat instance. Required if `authMode` is "BASIC". Defaults to an empty string.
*/
readonly username: pulumi.Output<string | undefined>;
/**
* The vendor of the preheat instance. Must be either "dragonfly" or "kraken".
*/
readonly vendor: pulumi.Output<string>;
/**
* Create a PreheatInstance 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: PreheatInstanceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering PreheatInstance resources.
*/
export interface PreheatInstanceState {
/**
* The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
*/
authMode?: pulumi.Input<string>;
/**
* Whether the preheat instance is the default instance. Defaults to false.
*/
default?: pulumi.Input<boolean>;
/**
* The description of the preheat instance. Defaults to an empty string.
*/
description?: pulumi.Input<string>;
/**
* Whether the preheat instance is enabled. Defaults to true.
*/
enabled?: pulumi.Input<boolean>;
/**
* The endpoint of the preheat instance.
*/
endpoint?: pulumi.Input<string>;
/**
* Whether to allow insecure connections to the preheat instance. Defaults to false.
*/
insecure?: pulumi.Input<boolean>;
/**
* The name of the preheat instance.
*/
name?: pulumi.Input<string>;
/**
* The password for the preheat instance. Required if `authMode` is "BASIC". Defaults to an empty string.
*/
password?: pulumi.Input<string>;
/**
* The token for the preheat instance. Required if `authMode` is "OAUTH". Defaults to an empty string.
*/
token?: pulumi.Input<string>;
/**
* The username for the preheat instance. Required if `authMode` is "BASIC". Defaults to an empty string.
*/
username?: pulumi.Input<string>;
/**
* The vendor of the preheat instance. Must be either "dragonfly" or "kraken".
*/
vendor?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a PreheatInstance resource.
*/
export interface PreheatInstanceArgs {
/**
* The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
*/
authMode?: pulumi.Input<string>;
/**
* Whether the preheat instance is the default instance. Defaults to false.
*/
default?: pulumi.Input<boolean>;
/**
* The description of the preheat instance. Defaults to an empty string.
*/
description?: pulumi.Input<string>;
/**
* Whether the preheat instance is enabled. Defaults to true.
*/
enabled?: pulumi.Input<boolean>;
/**
* The endpoint of the preheat instance.
*/
endpoint: pulumi.Input<string>;
/**
* Whether to allow insecure connections to the preheat instance. Defaults to false.
*/
insecure?: pulumi.Input<boolean>;
/**
* The name of the preheat instance.
*/
name?: pulumi.Input<string>;
/**
* The password for the preheat instance. Required if `authMode` is "BASIC". Defaults to an empty string.
*/
password?: pulumi.Input<string>;
/**
* The token for the preheat instance. Required if `authMode` is "OAUTH". Defaults to an empty string.
*/
token?: pulumi.Input<string>;
/**
* The username for the preheat instance. Required if `authMode` is "BASIC". Defaults to an empty string.
*/
username?: pulumi.Input<string>;
/**
* The vendor of the preheat instance. Must be either "dragonfly" or "kraken".
*/
vendor: pulumi.Input<string>;
}