UNPKG

@emailbob/twingate

Version:

A Pulumi package for creating and managing Twingate cloud resources.

70 lines (69 loc) 3.4 kB
import * as pulumi from "@pulumi/pulumi"; /** * The provider type for the twingate 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 access key for API operations. You can retrieve this from the Twingate Admin Console * ([documentation](https://docs.twingate.com/docs/api-overview)). Alternatively, this can be specified using the * TWINGATE_API_TOKEN environment variable. */ readonly apiToken: pulumi.Output<string | undefined>; /** * Your Twingate network ID for API operations. You can find it in the Admin Console URL, for example: * `autoco.twingate.com`, where `autoco` is your network ID Alternatively, this can be specified using the TWINGATE_NETWORK * environment variable. */ readonly network: pulumi.Output<string | undefined>; /** * The default is 'twingate.com' This is optional and shouldn't be changed under normal circumstances. */ readonly url: 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 access key for API operations. You can retrieve this from the Twingate Admin Console * ([documentation](https://docs.twingate.com/docs/api-overview)). Alternatively, this can be specified using the * TWINGATE_API_TOKEN environment variable. */ apiToken?: pulumi.Input<string>; /** * Specifies a retry limit for the http requests made. The default value is 10. Alternatively, this can be specified using * the TWINGATE_HTTP_MAX_RETRY environment variable */ httpMaxRetry?: pulumi.Input<number>; /** * Specifies a time limit in seconds for the http requests made. The default value is 35 seconds. Alternatively, this can * be specified using the TWINGATE_HTTP_TIMEOUT environment variable */ httpTimeout?: pulumi.Input<number>; /** * Your Twingate network ID for API operations. You can find it in the Admin Console URL, for example: * `autoco.twingate.com`, where `autoco` is your network ID Alternatively, this can be specified using the TWINGATE_NETWORK * environment variable. */ network?: pulumi.Input<string>; /** * The default is 'twingate.com' This is optional and shouldn't be changed under normal circumstances. */ url?: pulumi.Input<string>; }