@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
180 lines (179 loc) • 4.88 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = new meraki.networks.Base("example", {
* name: "Main Office",
* notes: "Additional description of the network",
* organizationId: "string",
* productTypes: [
* "appliance",
* "switch",
* "wireless",
* ],
* tags: [
* "tag1",
* "tag2",
* ],
* timeZone: "America/Los_Angeles",
* });
* export const merakiNetworksExample = example;
* ```
*
* ## Import
*
* ```sh
* $ pulumi import meraki:networks/base:base example "network_id,organization_id"
* ```
*/
export declare class Base extends pulumi.CustomResource {
/**
* Get an existing Base resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BaseState, opts?: pulumi.CustomResourceOptions): Base;
/**
* Returns true if the given object is an instance of Base. 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 Base;
/**
* Enrollment string for the network
*/
readonly enrollmentString: pulumi.Output<string>;
/**
* If the network is bound to a config template
*/
readonly isBoundToConfigTemplate: pulumi.Output<boolean>;
/**
* Network name
*/
readonly name: pulumi.Output<string>;
/**
* networkId path parameter. Network ID
*/
readonly networkId: pulumi.Output<string>;
/**
* Notes for the network
*/
readonly notes: pulumi.Output<string>;
/**
* Organization ID
*/
readonly organizationId: pulumi.Output<string>;
/**
* List of the product types that the network supports
*/
readonly productTypes: pulumi.Output<string[]>;
/**
* Network tags
*/
readonly tags: pulumi.Output<string[]>;
/**
* Timezone of the network
*/
readonly timeZone: pulumi.Output<string>;
/**
* URL to the network Dashboard UI
*/
readonly url: pulumi.Output<string>;
/**
* Create a Base 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: BaseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering base resources.
*/
export interface BaseState {
/**
* Enrollment string for the network
*/
enrollmentString?: pulumi.Input<string>;
/**
* If the network is bound to a config template
*/
isBoundToConfigTemplate?: pulumi.Input<boolean>;
/**
* Network name
*/
name?: pulumi.Input<string>;
/**
* networkId path parameter. Network ID
*/
networkId?: pulumi.Input<string>;
/**
* Notes for the network
*/
notes?: pulumi.Input<string>;
/**
* Organization ID
*/
organizationId?: pulumi.Input<string>;
/**
* List of the product types that the network supports
*/
productTypes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Network tags
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Timezone of the network
*/
timeZone?: pulumi.Input<string>;
/**
* URL to the network Dashboard UI
*/
url?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Base resource.
*/
export interface BaseArgs {
/**
* Enrollment string for the network
*/
enrollmentString?: pulumi.Input<string>;
/**
* Network name
*/
name?: pulumi.Input<string>;
/**
* networkId path parameter. Network ID
*/
networkId?: pulumi.Input<string>;
/**
* Notes for the network
*/
notes?: pulumi.Input<string>;
/**
* Organization ID
*/
organizationId: pulumi.Input<string>;
/**
* List of the product types that the network supports
*/
productTypes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Network tags
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Timezone of the network
*/
timeZone?: pulumi.Input<string>;
}