@pulumi/juniper-mist
Version:
A Pulumi package for creating and managing Juniper Mist resources.
139 lines (138 loc) • 5.16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* This resource manages Alarm Templates.
*
* An Alarm Template is a set of Alarm Rules that could be applied to one or more sites (while each site can only pick one Alarm Template), or to the whole org.
*
* Once created, the Alarm template must be assigned with the `alarmtemplateId` attribute to one of the following:
* * the whole org with the `junipermist.org.base` resource
* * one or multiple sites with the `junipermist.site.base` resource
*
* It is possible to use the `junipermist.getConstAlarms` data source to get a list of the available alarms
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as junipermist from "@pulumi/juniper-mist";
*
* const alarmtemplateOne = new junipermist.org.Alarmtemplate("alarmtemplate_one", {
* orgId: terraformTest.id,
* name: "alarmtemplate_one",
* delivery: {
* enabled: true,
* toOrgAdmins: true,
* additionalEmails: ["admin@mycorp.net"],
* },
* rules: {
* health_check_failed: {
* enabled: true,
* },
* insufficient_capacity: {
* enabled: true,
* },
* insufficient_coverage: {
* enabled: true,
* },
* infra_arp_failure: {
* enabled: true,
* },
* arp_failure: {
* enabled: true,
* },
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `mist_org_alarmtemplate` with:
*
* Org RF Template can be imported by specifying the org_id and the alarmtemplate_id
*
* ```sh
* $ pulumi import junipermist:org/alarmtemplate:Alarmtemplate alarmtemplate_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a.d3c42998-9012-4859-9743-6b9bee475309
* ```
*/
export declare class Alarmtemplate extends pulumi.CustomResource {
/**
* Get an existing Alarmtemplate 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?: AlarmtemplateState, opts?: pulumi.CustomResourceOptions): Alarmtemplate;
/**
* Returns true if the given object is an instance of Alarmtemplate. 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 Alarmtemplate;
/**
* Delivery object to configure the alarm delivery
*/
readonly delivery: pulumi.Output<outputs.org.AlarmtemplateDelivery>;
/**
* Some string to name the alarm template
*/
readonly name: pulumi.Output<string>;
readonly orgId: pulumi.Output<string>;
/**
* Alarm Rules object to configure the individual alarm keys/types. Property key is the alarm name (list available with the `junipermist.getConstAlarms` data source).
*/
readonly rules: pulumi.Output<{
[key: string]: outputs.org.AlarmtemplateRules;
}>;
/**
* Create a Alarmtemplate 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: AlarmtemplateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Alarmtemplate resources.
*/
export interface AlarmtemplateState {
/**
* Delivery object to configure the alarm delivery
*/
delivery?: pulumi.Input<inputs.org.AlarmtemplateDelivery>;
/**
* Some string to name the alarm template
*/
name?: pulumi.Input<string>;
orgId?: pulumi.Input<string>;
/**
* Alarm Rules object to configure the individual alarm keys/types. Property key is the alarm name (list available with the `junipermist.getConstAlarms` data source).
*/
rules?: pulumi.Input<{
[key: string]: pulumi.Input<inputs.org.AlarmtemplateRules>;
}>;
}
/**
* The set of arguments for constructing a Alarmtemplate resource.
*/
export interface AlarmtemplateArgs {
/**
* Delivery object to configure the alarm delivery
*/
delivery: pulumi.Input<inputs.org.AlarmtemplateDelivery>;
/**
* Some string to name the alarm template
*/
name?: pulumi.Input<string>;
orgId: pulumi.Input<string>;
/**
* Alarm Rules object to configure the individual alarm keys/types. Property key is the alarm name (list available with the `junipermist.getConstAlarms` data source).
*/
rules: pulumi.Input<{
[key: string]: pulumi.Input<inputs.org.AlarmtemplateRules>;
}>;
}