@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
62 lines (61 loc) • 2.67 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The provider type for the meraki 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;
/**
* Cisco Meraki base URL, FQDN or IP. If not set, it uses the MERAKI_BASE_URL environment variable. Default is
* (https://api.meraki.com/)
*/
readonly merakiBaseUrl: pulumi.Output<string | undefined>;
/**
* Cisco Meraki merakiDashboardApiKey to authenticate. If not set, it uses the MERAKI_DASHBOARD_API_KEY environment
* variable.
*/
readonly merakiDashboardApiKey: pulumi.Output<string | undefined>;
/**
* Flag for Cisco Meraki to enable debugging. If not set, it uses the MERAKI_DEBUG environment variable defaults to
* `false`.
*/
readonly merakiDebug: 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 {
/**
* Cisco Meraki base URL, FQDN or IP. If not set, it uses the MERAKI_BASE_URL environment variable. Default is
* (https://api.meraki.com/)
*/
merakiBaseUrl?: pulumi.Input<string>;
/**
* Cisco Meraki merakiDashboardApiKey to authenticate. If not set, it uses the MERAKI_DASHBOARD_API_KEY environment
* variable.
*/
merakiDashboardApiKey?: pulumi.Input<string>;
/**
* Flag for Cisco Meraki to enable debugging. If not set, it uses the MERAKI_DEBUG environment variable defaults to
* `false`.
*/
merakiDebug?: pulumi.Input<string>;
/**
* Flag requests per second allowed for client. Default is (10)
*/
merakiRequestsPerSecond?: pulumi.Input<number>;
}