@cuemby/equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
79 lines (78 loc) • 3.09 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The provider type for the equinix 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 Equinix Metal API auth key for API operations
*/
readonly authToken: pulumi.Output<string | undefined>;
/**
* API Consumer Key available under My Apps section in developer portal
*/
readonly clientId: pulumi.Output<string | undefined>;
/**
* API Consumer secret available under My Apps section in developer portal
*/
readonly clientSecret: pulumi.Output<string | undefined>;
/**
* The Equinix API base URL to point out desired environment. Defaults to https://api.equinix.com
*/
readonly endpoint: pulumi.Output<string | undefined>;
/**
* API token from the developer sandbox
*/
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);
}
/**
* The set of arguments for constructing a Provider resource.
*/
export interface ProviderArgs {
/**
* The Equinix Metal API auth key for API operations
*/
authToken?: pulumi.Input<string>;
/**
* API Consumer Key available under My Apps section in developer portal
*/
clientId?: pulumi.Input<string>;
/**
* API Consumer secret available under My Apps section in developer portal
*/
clientSecret?: pulumi.Input<string>;
/**
* The Equinix API base URL to point out desired environment. Defaults to https://api.equinix.com
*/
endpoint?: pulumi.Input<string>;
maxRetries?: pulumi.Input<number>;
maxRetryWaitSeconds?: pulumi.Input<number>;
/**
* The duration of time, in seconds, that the Equinix Platform API Client should wait before canceling an API request.
* Defaults to 30
*/
requestTimeout?: pulumi.Input<number>;
/**
* The maximum number of records in a single response for REST queries that produce paginated responses
*/
responseMaxPageSize?: pulumi.Input<number>;
/**
* API token from the developer sandbox
*/
token?: pulumi.Input<string>;
}