@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
136 lines (135 loc) • 4.09 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = new meraki.organizations.Base("example", {
* management: {
* details: [{
* name: "MSP ID",
* value: "123456",
* }],
* },
* name: "My organization",
* });
* export const merakiOrganizationsExample = example;
* ```
*
* ## Import
*
* ```sh
* $ pulumi import meraki:organizations/base:base example "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;
/**
* API related settings
*/
readonly api: pulumi.Output<outputs.organizations.BaseApi>;
/**
* Data for this organization
*/
readonly cloud: pulumi.Output<outputs.organizations.BaseCloud>;
/**
* Licensing related settings
*/
readonly licensing: pulumi.Output<outputs.organizations.BaseLicensing>;
/**
* Information about the organization's management system
*/
readonly management: pulumi.Output<outputs.organizations.BaseManagement>;
/**
* Organization name
*/
readonly name: pulumi.Output<string>;
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId: pulumi.Output<string>;
/**
* Organization URL
*/
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 {
/**
* API related settings
*/
api?: pulumi.Input<inputs.organizations.BaseApi>;
/**
* Data for this organization
*/
cloud?: pulumi.Input<inputs.organizations.BaseCloud>;
/**
* Licensing related settings
*/
licensing?: pulumi.Input<inputs.organizations.BaseLicensing>;
/**
* Information about the organization's management system
*/
management?: pulumi.Input<inputs.organizations.BaseManagement>;
/**
* Organization name
*/
name?: pulumi.Input<string>;
/**
* organizationId path parameter. Organization ID
*/
organizationId?: pulumi.Input<string>;
/**
* Organization URL
*/
url?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Base resource.
*/
export interface BaseArgs {
/**
* API related settings
*/
api?: pulumi.Input<inputs.organizations.BaseApi>;
/**
* Information about the organization's management system
*/
management?: pulumi.Input<inputs.organizations.BaseManagement>;
/**
* Organization name
*/
name?: pulumi.Input<string>;
/**
* organizationId path parameter. Organization ID
*/
organizationId?: pulumi.Input<string>;
}