@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
98 lines (97 loc) • 3.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The provider type for the digitalocean 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;
/**
* The URL to use for the DigitalOcean API.
*/
readonly apiEndpoint: pulumi.Output<string | undefined>;
/**
* The access key ID for Spaces API operations.
*/
readonly spacesAccessId: pulumi.Output<string | undefined>;
/**
* The URL to use for the DigitalOcean Spaces API.
*/
readonly spacesEndpoint: pulumi.Output<string | undefined>;
/**
* The secret access key for Spaces API operations.
*/
readonly spacesSecretKey: pulumi.Output<string | undefined>;
/**
* The token key for API operations.
*/
readonly token: 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 {
/**
* The URL to use for the DigitalOcean API.
*/
apiEndpoint?: pulumi.Input<string>;
/**
* The maximum number of retries on a failed API request.
*/
httpRetryMax?: pulumi.Input<number>;
/**
* The maximum wait time (in seconds) between failed API requests.
*/
httpRetryWaitMax?: pulumi.Input<number>;
/**
* The minimum wait time (in seconds) between failed API requests.
*/
httpRetryWaitMin?: pulumi.Input<number>;
/**
* The rate of requests per second to limit the HTTP client.
*/
requestsPerSecond?: pulumi.Input<number>;
/**
* The access key ID for Spaces API operations.
*/
spacesAccessId?: pulumi.Input<string>;
/**
* The URL to use for the DigitalOcean Spaces API.
*/
spacesEndpoint?: pulumi.Input<string>;
/**
* The secret access key for Spaces API operations.
*/
spacesSecretKey?: pulumi.Input<string>;
/**
* The token key for API operations.
*/
token?: pulumi.Input<string>;
}
export declare namespace Provider {
/**
* The results of the Provider.terraformConfig method.
*/
interface TerraformConfigResult {
readonly result: {
[key: string]: any;
};
}
}