@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
360 lines (359 loc) • 14.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Manages Grafana Alerting contact points.
*
* * Official documentation
* * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#contact-points)
*
* This resource requires Grafana 9.1.0 or later.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const myContactPoint = new grafana.alerting.ContactPoint("my_contact_point", {
* name: "My Contact Point",
* emails: [{
* addresses: [
* "one@company.org",
* "two@company.org",
* ],
* message: "{{ len .Alerts.Firing }} firing.",
* subject: "{{ template \"default.title\" .}}",
* singleEmail: true,
* disableResolveMessage: false,
* }],
* });
* ```
*
* ## Import
*
* ```sh
* $ pulumi import grafana:index/contactPoint:ContactPoint name "{{ name }}"
* ```
*
* ```sh
* $ pulumi import grafana:index/contactPoint:ContactPoint name "{{ orgID }}:{{ name }}"
* ```
*
* @deprecated grafana.index/contactpoint.ContactPoint has been deprecated in favor of grafana.alerting/contactpoint.ContactPoint
*/
export declare class ContactPoint extends pulumi.CustomResource {
/**
* Get an existing ContactPoint 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?: ContactPointState, opts?: pulumi.CustomResourceOptions): ContactPoint;
/**
* Returns true if the given object is an instance of ContactPoint. 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 ContactPoint;
/**
* A contact point that sends notifications to other Alertmanager instances.
*/
readonly alertmanagers: pulumi.Output<outputs.ContactPointAlertmanager[] | undefined>;
/**
* A contact point that sends notifications to DingDing.
*/
readonly dingdings: pulumi.Output<outputs.ContactPointDingding[] | undefined>;
readonly disableProvenance: pulumi.Output<boolean | undefined>;
/**
* A contact point that sends notifications as Discord messages
*/
readonly discords: pulumi.Output<outputs.ContactPointDiscord[] | undefined>;
/**
* A contact point that sends notifications to an email address.
*/
readonly emails: pulumi.Output<outputs.ContactPointEmail[] | undefined>;
/**
* A contact point that sends notifications to Google Chat.
*/
readonly googlechats: pulumi.Output<outputs.ContactPointGooglechat[] | undefined>;
/**
* A contact point that publishes notifications to Apache Kafka topics.
*/
readonly kafkas: pulumi.Output<outputs.ContactPointKafka[] | undefined>;
/**
* A contact point that sends notifications to LINE.me.
*/
readonly lines: pulumi.Output<outputs.ContactPointLine[] | undefined>;
/**
* The name of the contact point.
*/
readonly name: pulumi.Output<string>;
/**
* A contact point that sends notifications to Grafana On-Call.
*/
readonly oncalls: pulumi.Output<outputs.ContactPointOncall[] | undefined>;
/**
* A contact point that sends notifications to OpsGenie.
*/
readonly opsgenies: pulumi.Output<outputs.ContactPointOpsgeny[] | undefined>;
/**
* The Organization ID. If not set, the Org ID defined in the provider block will be used.
*/
readonly orgId: pulumi.Output<string | undefined>;
/**
* A contact point that sends notifications to PagerDuty.
*/
readonly pagerduties: pulumi.Output<outputs.ContactPointPagerduty[] | undefined>;
/**
* A contact point that sends notifications to Pushover.
*/
readonly pushovers: pulumi.Output<outputs.ContactPointPushover[] | undefined>;
/**
* A contact point that sends notifications to SensuGo.
*/
readonly sensugos: pulumi.Output<outputs.ContactPointSensugo[] | undefined>;
/**
* A contact point that sends notifications to Slack.
*/
readonly slacks: pulumi.Output<outputs.ContactPointSlack[] | undefined>;
/**
* A contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana.
*/
readonly sns: pulumi.Output<outputs.ContactPointSn[] | undefined>;
/**
* A contact point that sends notifications to Microsoft Teams.
*/
readonly teams: pulumi.Output<outputs.ContactPointTeam[] | undefined>;
/**
* A contact point that sends notifications to Telegram.
*/
readonly telegrams: pulumi.Output<outputs.ContactPointTelegram[] | undefined>;
/**
* A contact point that sends notifications to Threema.
*/
readonly threemas: pulumi.Output<outputs.ContactPointThreema[] | undefined>;
/**
* A contact point that sends notifications to VictorOps (now known as Splunk OnCall).
*/
readonly victorops: pulumi.Output<outputs.ContactPointVictorop[] | undefined>;
/**
* A contact point that sends notifications to Cisco Webex.
*/
readonly webexes: pulumi.Output<outputs.ContactPointWebex[] | undefined>;
/**
* A contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config
*/
readonly webhooks: pulumi.Output<outputs.ContactPointWebhook[] | undefined>;
/**
* A contact point that sends notifications to WeCom.
*/
readonly wecoms: pulumi.Output<outputs.ContactPointWecom[] | undefined>;
/**
* Create a ContactPoint 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.
*/
/** @deprecated grafana.index/contactpoint.ContactPoint has been deprecated in favor of grafana.alerting/contactpoint.ContactPoint */
constructor(name: string, args?: ContactPointArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ContactPoint resources.
*/
export interface ContactPointState {
/**
* A contact point that sends notifications to other Alertmanager instances.
*/
alertmanagers?: pulumi.Input<pulumi.Input<inputs.ContactPointAlertmanager>[]>;
/**
* A contact point that sends notifications to DingDing.
*/
dingdings?: pulumi.Input<pulumi.Input<inputs.ContactPointDingding>[]>;
disableProvenance?: pulumi.Input<boolean>;
/**
* A contact point that sends notifications as Discord messages
*/
discords?: pulumi.Input<pulumi.Input<inputs.ContactPointDiscord>[]>;
/**
* A contact point that sends notifications to an email address.
*/
emails?: pulumi.Input<pulumi.Input<inputs.ContactPointEmail>[]>;
/**
* A contact point that sends notifications to Google Chat.
*/
googlechats?: pulumi.Input<pulumi.Input<inputs.ContactPointGooglechat>[]>;
/**
* A contact point that publishes notifications to Apache Kafka topics.
*/
kafkas?: pulumi.Input<pulumi.Input<inputs.ContactPointKafka>[]>;
/**
* A contact point that sends notifications to LINE.me.
*/
lines?: pulumi.Input<pulumi.Input<inputs.ContactPointLine>[]>;
/**
* The name of the contact point.
*/
name?: pulumi.Input<string>;
/**
* A contact point that sends notifications to Grafana On-Call.
*/
oncalls?: pulumi.Input<pulumi.Input<inputs.ContactPointOncall>[]>;
/**
* A contact point that sends notifications to OpsGenie.
*/
opsgenies?: pulumi.Input<pulumi.Input<inputs.ContactPointOpsgeny>[]>;
/**
* The Organization ID. If not set, the Org ID defined in the provider block will be used.
*/
orgId?: pulumi.Input<string>;
/**
* A contact point that sends notifications to PagerDuty.
*/
pagerduties?: pulumi.Input<pulumi.Input<inputs.ContactPointPagerduty>[]>;
/**
* A contact point that sends notifications to Pushover.
*/
pushovers?: pulumi.Input<pulumi.Input<inputs.ContactPointPushover>[]>;
/**
* A contact point that sends notifications to SensuGo.
*/
sensugos?: pulumi.Input<pulumi.Input<inputs.ContactPointSensugo>[]>;
/**
* A contact point that sends notifications to Slack.
*/
slacks?: pulumi.Input<pulumi.Input<inputs.ContactPointSlack>[]>;
/**
* A contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana.
*/
sns?: pulumi.Input<pulumi.Input<inputs.ContactPointSn>[]>;
/**
* A contact point that sends notifications to Microsoft Teams.
*/
teams?: pulumi.Input<pulumi.Input<inputs.ContactPointTeam>[]>;
/**
* A contact point that sends notifications to Telegram.
*/
telegrams?: pulumi.Input<pulumi.Input<inputs.ContactPointTelegram>[]>;
/**
* A contact point that sends notifications to Threema.
*/
threemas?: pulumi.Input<pulumi.Input<inputs.ContactPointThreema>[]>;
/**
* A contact point that sends notifications to VictorOps (now known as Splunk OnCall).
*/
victorops?: pulumi.Input<pulumi.Input<inputs.ContactPointVictorop>[]>;
/**
* A contact point that sends notifications to Cisco Webex.
*/
webexes?: pulumi.Input<pulumi.Input<inputs.ContactPointWebex>[]>;
/**
* A contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config
*/
webhooks?: pulumi.Input<pulumi.Input<inputs.ContactPointWebhook>[]>;
/**
* A contact point that sends notifications to WeCom.
*/
wecoms?: pulumi.Input<pulumi.Input<inputs.ContactPointWecom>[]>;
}
/**
* The set of arguments for constructing a ContactPoint resource.
*/
export interface ContactPointArgs {
/**
* A contact point that sends notifications to other Alertmanager instances.
*/
alertmanagers?: pulumi.Input<pulumi.Input<inputs.ContactPointAlertmanager>[]>;
/**
* A contact point that sends notifications to DingDing.
*/
dingdings?: pulumi.Input<pulumi.Input<inputs.ContactPointDingding>[]>;
disableProvenance?: pulumi.Input<boolean>;
/**
* A contact point that sends notifications as Discord messages
*/
discords?: pulumi.Input<pulumi.Input<inputs.ContactPointDiscord>[]>;
/**
* A contact point that sends notifications to an email address.
*/
emails?: pulumi.Input<pulumi.Input<inputs.ContactPointEmail>[]>;
/**
* A contact point that sends notifications to Google Chat.
*/
googlechats?: pulumi.Input<pulumi.Input<inputs.ContactPointGooglechat>[]>;
/**
* A contact point that publishes notifications to Apache Kafka topics.
*/
kafkas?: pulumi.Input<pulumi.Input<inputs.ContactPointKafka>[]>;
/**
* A contact point that sends notifications to LINE.me.
*/
lines?: pulumi.Input<pulumi.Input<inputs.ContactPointLine>[]>;
/**
* The name of the contact point.
*/
name?: pulumi.Input<string>;
/**
* A contact point that sends notifications to Grafana On-Call.
*/
oncalls?: pulumi.Input<pulumi.Input<inputs.ContactPointOncall>[]>;
/**
* A contact point that sends notifications to OpsGenie.
*/
opsgenies?: pulumi.Input<pulumi.Input<inputs.ContactPointOpsgeny>[]>;
/**
* The Organization ID. If not set, the Org ID defined in the provider block will be used.
*/
orgId?: pulumi.Input<string>;
/**
* A contact point that sends notifications to PagerDuty.
*/
pagerduties?: pulumi.Input<pulumi.Input<inputs.ContactPointPagerduty>[]>;
/**
* A contact point that sends notifications to Pushover.
*/
pushovers?: pulumi.Input<pulumi.Input<inputs.ContactPointPushover>[]>;
/**
* A contact point that sends notifications to SensuGo.
*/
sensugos?: pulumi.Input<pulumi.Input<inputs.ContactPointSensugo>[]>;
/**
* A contact point that sends notifications to Slack.
*/
slacks?: pulumi.Input<pulumi.Input<inputs.ContactPointSlack>[]>;
/**
* A contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana.
*/
sns?: pulumi.Input<pulumi.Input<inputs.ContactPointSn>[]>;
/**
* A contact point that sends notifications to Microsoft Teams.
*/
teams?: pulumi.Input<pulumi.Input<inputs.ContactPointTeam>[]>;
/**
* A contact point that sends notifications to Telegram.
*/
telegrams?: pulumi.Input<pulumi.Input<inputs.ContactPointTelegram>[]>;
/**
* A contact point that sends notifications to Threema.
*/
threemas?: pulumi.Input<pulumi.Input<inputs.ContactPointThreema>[]>;
/**
* A contact point that sends notifications to VictorOps (now known as Splunk OnCall).
*/
victorops?: pulumi.Input<pulumi.Input<inputs.ContactPointVictorop>[]>;
/**
* A contact point that sends notifications to Cisco Webex.
*/
webexes?: pulumi.Input<pulumi.Input<inputs.ContactPointWebex>[]>;
/**
* A contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config
*/
webhooks?: pulumi.Input<pulumi.Input<inputs.ContactPointWebhook>[]>;
/**
* A contact point that sends notifications to WeCom.
*/
wecoms?: pulumi.Input<pulumi.Input<inputs.ContactPointWecom>[]>;
}