@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
44 lines (43 loc) • 1.91 kB
TypeScript
/**
* The Equinix Metal API auth key for API operations
*/
export declare const authToken: string | undefined;
/**
* API Consumer Key available under "My Apps" in developer portal. This argument can also be specified with the
* `EQUINIX_API_CLIENTID` shell environment variable.
*/
export declare const clientId: string | undefined;
/**
* API Consumer secret available under "My Apps" in developer portal. This argument can also be specified with the
* `EQUINIX_API_CLIENTSECRET` shell environment variable.
*/
export declare const clientSecret: string | undefined;
/**
* The Equinix API base URL to point out desired environment. This argument can also be specified with the
* `EQUINIX_API_ENDPOINT` shell environment variable. (Defaults to `https://api.equinix.com`)
*/
export declare const endpoint: string | undefined;
/**
* Maximum number of retries in case of network failure.
*/
export declare const maxRetries: number | undefined;
/**
* Maximum number of seconds to wait before retrying a request.
*/
export declare const maxRetryWaitSeconds: number | undefined;
/**
* The duration of time, in seconds, that the Equinix Platform API Client should wait before canceling an API request.
* Canceled requests may still result in provisioned resources. (Defaults to `30`)
*/
export declare const requestTimeout: number | undefined;
/**
* The maximum number of records in a single response for REST queries that produce paginated responses. (Default is client
* specific)
*/
export declare const responseMaxPageSize: number | undefined;
/**
* API tokens are generated from API Consumer clients using the [OAuth2
* API](https://developer.equinix.com/dev-docs/fabric/getting-started/getting-access-token#request-access-and-refresh-tokens).
* This argument can also be specified with the `EQUINIX_API_TOKEN` shell environment variable.
*/
export declare const token: string | undefined;