@upcloud/pulumi-upcloud
Version:
A Pulumi package for creating and managing UpCloud resources.
82 lines (81 loc) • 3.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The provider type for the upcloud package. By default, resources use package-wide configuration
* settings, however an explicit `Provider` instance may be created and passed during resource
* construction to achieve fine-grained programmatic control over provider settings. See the
* [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.
*/
export declare class Provider extends pulumi.ProviderResource {
/**
* Returns true if the given object is an instance of Provider. 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 Provider;
/**
* Password for UpCloud API user. Can also be configured using the `UPCLOUD_PASSWORD` environment variable.
*/
readonly password: pulumi.Output<string | undefined>;
/**
* Token for authenticating to UpCloud API. Can also be configured using the `UPCLOUD_TOKEN` environment variable or using the system keyring. Use `upctl account login` command to save a token to the system keyring. (EXPERIMENTAL)
*/
readonly token: pulumi.Output<string | undefined>;
/**
* UpCloud username with API access. Can also be configured using the `UPCLOUD_USERNAME` environment variable.
*/
readonly username: pulumi.Output<string | undefined>;
/**
* Create a Provider 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?: ProviderArgs, opts?: pulumi.ResourceOptions);
/**
* This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.
*/
terraformConfig(): pulumi.Output<Provider.TerraformConfigResult>;
}
/**
* The set of arguments for constructing a Provider resource.
*/
export interface ProviderArgs {
/**
* Password for UpCloud API user. Can also be configured using the `UPCLOUD_PASSWORD` environment variable.
*/
password?: pulumi.Input<string>;
/**
* The duration (in seconds) that the provider waits for an HTTP request towards UpCloud API to complete. Defaults to 120 seconds
*/
requestTimeoutSec?: pulumi.Input<number>;
/**
* Maximum number of retries
*/
retryMax?: pulumi.Input<number>;
/**
* Maximum time to wait between retries
*/
retryWaitMaxSec?: pulumi.Input<number>;
/**
* Minimum time to wait between retries
*/
retryWaitMinSec?: pulumi.Input<number>;
/**
* Token for authenticating to UpCloud API. Can also be configured using the `UPCLOUD_TOKEN` environment variable or using the system keyring. Use `upctl account login` command to save a token to the system keyring. (EXPERIMENTAL)
*/
token?: pulumi.Input<string>;
/**
* UpCloud username with API access. Can also be configured using the `UPCLOUD_USERNAME` environment variable.
*/
username?: pulumi.Input<string>;
}
export declare namespace Provider {
/**
* The results of the Provider.terraformConfig method.
*/
interface TerraformConfigResult {
readonly result: {
[key: string]: any;
};
}
}