@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
152 lines (151 loc) • 5.86 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.networks.Settings("example", {
* localStatusPage: {
* authentication: {
* enabled: false,
* password: "miles123",
* },
* },
* localStatusPageEnabled: true,
* namedVlans: {
* enabled: true,
* },
* networkId: "string",
* remoteStatusPageEnabled: true,
* securePort: {
* enabled: false,
* },
* });
* export const merakiNetworksSettingsExample = example;
* ```
*
* ## Import
*
* ```sh
* $ pulumi import meraki:networks/settings:Settings example "network_id"
* ```
*/
export declare class Settings extends pulumi.CustomResource {
/**
* Get an existing Settings 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?: SettingsState, opts?: pulumi.CustomResourceOptions): Settings;
/**
* Returns true if the given object is an instance of Settings. 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 Settings;
/**
* A hash of FIPS options applied to the Network
*/
readonly fips: pulumi.Output<outputs.networks.SettingsFips>;
/**
* A hash of Local Status page(s)' authentication options applied to the Network.
*/
readonly localStatusPage: pulumi.Output<outputs.networks.SettingsLocalStatusPage>;
/**
* Enables / disables the local device status pages (\n\nmy.meraki.com, \n\n\n\nap.meraki.com, \n\n\n\nswitch.meraki.com, \n\n\n\nwired.meraki.com\n\n). Optional (defaults to false)
*/
readonly localStatusPageEnabled: pulumi.Output<boolean>;
/**
* A hash of Named VLANs options applied to the Network.
*/
readonly namedVlans: pulumi.Output<outputs.networks.SettingsNamedVlans>;
/**
* networkId path parameter. Network ID
*/
readonly networkId: pulumi.Output<string>;
/**
* Enables / disables access to the device status page (\n\nhttp://[device's LAN IP])\n\n. Optional. Can only be set if localStatusPageEnabled is set to true
*/
readonly remoteStatusPageEnabled: pulumi.Output<boolean>;
/**
* A hash of SecureConnect options applied to the Network.
*/
readonly securePort: pulumi.Output<outputs.networks.SettingsSecurePort>;
/**
* Create a Settings 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: SettingsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Settings resources.
*/
export interface SettingsState {
/**
* A hash of FIPS options applied to the Network
*/
fips?: pulumi.Input<inputs.networks.SettingsFips>;
/**
* A hash of Local Status page(s)' authentication options applied to the Network.
*/
localStatusPage?: pulumi.Input<inputs.networks.SettingsLocalStatusPage>;
/**
* Enables / disables the local device status pages (\n\nmy.meraki.com, \n\n\n\nap.meraki.com, \n\n\n\nswitch.meraki.com, \n\n\n\nwired.meraki.com\n\n). Optional (defaults to false)
*/
localStatusPageEnabled?: pulumi.Input<boolean>;
/**
* A hash of Named VLANs options applied to the Network.
*/
namedVlans?: pulumi.Input<inputs.networks.SettingsNamedVlans>;
/**
* networkId path parameter. Network ID
*/
networkId?: pulumi.Input<string>;
/**
* Enables / disables access to the device status page (\n\nhttp://[device's LAN IP])\n\n. Optional. Can only be set if localStatusPageEnabled is set to true
*/
remoteStatusPageEnabled?: pulumi.Input<boolean>;
/**
* A hash of SecureConnect options applied to the Network.
*/
securePort?: pulumi.Input<inputs.networks.SettingsSecurePort>;
}
/**
* The set of arguments for constructing a Settings resource.
*/
export interface SettingsArgs {
/**
* A hash of Local Status page(s)' authentication options applied to the Network.
*/
localStatusPage?: pulumi.Input<inputs.networks.SettingsLocalStatusPage>;
/**
* Enables / disables the local device status pages (\n\nmy.meraki.com, \n\n\n\nap.meraki.com, \n\n\n\nswitch.meraki.com, \n\n\n\nwired.meraki.com\n\n). Optional (defaults to false)
*/
localStatusPageEnabled?: pulumi.Input<boolean>;
/**
* A hash of Named VLANs options applied to the Network.
*/
namedVlans?: pulumi.Input<inputs.networks.SettingsNamedVlans>;
/**
* networkId path parameter. Network ID
*/
networkId: pulumi.Input<string>;
/**
* Enables / disables access to the device status page (\n\nhttp://[device's LAN IP])\n\n. Optional. Can only be set if localStatusPageEnabled is set to true
*/
remoteStatusPageEnabled?: pulumi.Input<boolean>;
/**
* A hash of SecureConnect options applied to the Network.
*/
securePort?: pulumi.Input<inputs.networks.SettingsSecurePort>;
}