UNPKG

@lbrlabs/pulumi-grafana

Version:

A Pulumi package for creating and managing grafana.

117 lines (116 loc) 5.37 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * * [Official documentation](https://grafana.com/docs/oncall/latest/integrations/) * * [HTTP API](https://grafana.com/docs/oncall/latest/oncall-api-reference/) * * ## Import * * ```sh * $ pulumi import grafana:index/oncallIntegration:OncallIntegration integration_name {{integration_id}} * ``` */ export declare class OncallIntegration extends pulumi.CustomResource { /** * Get an existing OncallIntegration 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?: OncallIntegrationState, opts?: pulumi.CustomResourceOptions): OncallIntegration; /** * Returns true if the given object is an instance of OncallIntegration. 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 OncallIntegration; /** * The Default route for all alerts from the given integration */ readonly defaultRoute: pulumi.Output<outputs.OncallIntegrationDefaultRoute>; /** * The link for using in an integrated tool. */ readonly link: pulumi.Output<string>; /** * The name of the service integration. */ readonly name: pulumi.Output<string>; /** * The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana.getOncallTeam` datasource. */ readonly teamId: pulumi.Output<string | undefined>; /** * Jinja2 templates for Alert payload. */ readonly templates: pulumi.Output<outputs.OncallIntegrationTemplates | undefined>; /** * The type of integration. Can be grafana, grafana*alerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazon*sns, curler, sentry, formatted*webhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentry*platform, zabbix, prtg, slack*channel, inbound*email, direct_paging. */ readonly type: pulumi.Output<string>; /** * Create a OncallIntegration 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: OncallIntegrationArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering OncallIntegration resources. */ export interface OncallIntegrationState { /** * The Default route for all alerts from the given integration */ defaultRoute?: pulumi.Input<inputs.OncallIntegrationDefaultRoute>; /** * The link for using in an integrated tool. */ link?: pulumi.Input<string>; /** * The name of the service integration. */ name?: pulumi.Input<string>; /** * The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana.getOncallTeam` datasource. */ teamId?: pulumi.Input<string>; /** * Jinja2 templates for Alert payload. */ templates?: pulumi.Input<inputs.OncallIntegrationTemplates>; /** * The type of integration. Can be grafana, grafana*alerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazon*sns, curler, sentry, formatted*webhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentry*platform, zabbix, prtg, slack*channel, inbound*email, direct_paging. */ type?: pulumi.Input<string>; } /** * The set of arguments for constructing a OncallIntegration resource. */ export interface OncallIntegrationArgs { /** * The Default route for all alerts from the given integration */ defaultRoute: pulumi.Input<inputs.OncallIntegrationDefaultRoute>; /** * The name of the service integration. */ name?: pulumi.Input<string>; /** * The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana.getOncallTeam` datasource. */ teamId?: pulumi.Input<string>; /** * Jinja2 templates for Alert payload. */ templates?: pulumi.Input<inputs.OncallIntegrationTemplates>; /** * The type of integration. Can be grafana, grafana*alerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazon*sns, curler, sentry, formatted*webhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentry*platform, zabbix, prtg, slack*channel, inbound*email, direct_paging. */ type: pulumi.Input<string>; }