@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
150 lines (149 loc) • 5.23 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.SwitchPortSchedules("example", {
* name: "Weekdays schedule",
* networkId: "string",
* portSchedule: {
* friday: {
* active: true,
* from: "9:00",
* to: "17:00",
* },
* monday: {
* active: true,
* from: "9:00",
* to: "17:00",
* },
* saturday: {
* active: false,
* from: "0:00",
* to: "24:00",
* },
* sunday: {
* active: false,
* from: "0:00",
* to: "24:00",
* },
* thursday: {
* active: true,
* from: "9:00",
* to: "17:00",
* },
* tuesday: {
* active: true,
* from: "9:00",
* to: "17:00",
* },
* wednesday: {
* active: true,
* from: "9:00",
* to: "17:00",
* },
* },
* });
* export const merakiNetworksSwitchPortSchedulesExample = example;
* ```
*
* ## Import
*
* ```sh
* $ pulumi import meraki:networks/switchPortSchedules:SwitchPortSchedules example "network_id"
* ```
*/
export declare class SwitchPortSchedules extends pulumi.CustomResource {
/**
* Get an existing SwitchPortSchedules 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?: SwitchPortSchedulesState, opts?: pulumi.CustomResourceOptions): SwitchPortSchedules;
/**
* Returns true if the given object is an instance of SwitchPortSchedules. 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 SwitchPortSchedules;
/**
* The name for your port schedule. Required
*/
readonly name: pulumi.Output<string>;
/**
* networkId path parameter. Network ID
*/
readonly networkId: pulumi.Output<string>;
/**
* The schedule for switch port scheduling. Schedules are applied to days of the week.
* When it's empty, default schedule with all days of a week are configured.
* Any unspecified day in the schedule is added as a default schedule configuration of the day.
*/
readonly portSchedule: pulumi.Output<outputs.networks.SwitchPortSchedulesPortSchedule>;
/**
* portScheduleId path parameter. Port schedule ID
*/
readonly portScheduleId: pulumi.Output<string>;
/**
* Create a SwitchPortSchedules 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: SwitchPortSchedulesArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SwitchPortSchedules resources.
*/
export interface SwitchPortSchedulesState {
/**
* The name for your port schedule. Required
*/
name?: pulumi.Input<string>;
/**
* networkId path parameter. Network ID
*/
networkId?: pulumi.Input<string>;
/**
* The schedule for switch port scheduling. Schedules are applied to days of the week.
* When it's empty, default schedule with all days of a week are configured.
* Any unspecified day in the schedule is added as a default schedule configuration of the day.
*/
portSchedule?: pulumi.Input<inputs.networks.SwitchPortSchedulesPortSchedule>;
/**
* portScheduleId path parameter. Port schedule ID
*/
portScheduleId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SwitchPortSchedules resource.
*/
export interface SwitchPortSchedulesArgs {
/**
* The name for your port schedule. Required
*/
name?: pulumi.Input<string>;
/**
* networkId path parameter. Network ID
*/
networkId: pulumi.Input<string>;
/**
* The schedule for switch port scheduling. Schedules are applied to days of the week.
* When it's empty, default schedule with all days of a week are configured.
* Any unspecified day in the schedule is added as a default schedule configuration of the day.
*/
portSchedule?: pulumi.Input<inputs.networks.SwitchPortSchedulesPortSchedule>;
/**
* portScheduleId path parameter. Port schedule ID
*/
portScheduleId?: pulumi.Input<string>;
}