@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
103 lines (102 loc) • 4.02 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.TrafficAnalysis("example", {
* customPieChartItems: [{
* name: "Item from hostname",
* type: "host",
* value: "example.com",
* }],
* mode: "disabled",
* networkId: "string",
* });
* export const merakiNetworksTrafficAnalysisExample = example;
* ```
*
* ## Import
*
* ```sh
* $ pulumi import meraki:networks/trafficAnalysis:TrafficAnalysis example "network_id"
* ```
*/
export declare class TrafficAnalysis extends pulumi.CustomResource {
/**
* Get an existing TrafficAnalysis 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?: TrafficAnalysisState, opts?: pulumi.CustomResourceOptions): TrafficAnalysis;
/**
* Returns true if the given object is an instance of TrafficAnalysis. 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 TrafficAnalysis;
/**
* The list of items that make up the custom pie chart for traffic reporting.
*/
readonly customPieChartItems: pulumi.Output<outputs.networks.TrafficAnalysisCustomPieChartItem[]>;
/**
* The traffic analysis mode for the network. Can be one of 'disabled' (do not collect traffic types),
* 'basic' (collect generic traffic categories), or 'detailed' (collect destination hostnames).
*/
readonly mode: pulumi.Output<string>;
/**
* networkId path parameter. Network ID
*/
readonly networkId: pulumi.Output<string>;
/**
* Create a TrafficAnalysis 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: TrafficAnalysisArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TrafficAnalysis resources.
*/
export interface TrafficAnalysisState {
/**
* The list of items that make up the custom pie chart for traffic reporting.
*/
customPieChartItems?: pulumi.Input<pulumi.Input<inputs.networks.TrafficAnalysisCustomPieChartItem>[]>;
/**
* The traffic analysis mode for the network. Can be one of 'disabled' (do not collect traffic types),
* 'basic' (collect generic traffic categories), or 'detailed' (collect destination hostnames).
*/
mode?: pulumi.Input<string>;
/**
* networkId path parameter. Network ID
*/
networkId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a TrafficAnalysis resource.
*/
export interface TrafficAnalysisArgs {
/**
* The list of items that make up the custom pie chart for traffic reporting.
*/
customPieChartItems?: pulumi.Input<pulumi.Input<inputs.networks.TrafficAnalysisCustomPieChartItem>[]>;
/**
* The traffic analysis mode for the network. Can be one of 'disabled' (do not collect traffic types),
* 'basic' (collect generic traffic categories), or 'detailed' (collect destination hostnames).
*/
mode?: pulumi.Input<string>;
/**
* networkId path parameter. Network ID
*/
networkId: pulumi.Input<string>;
}