UNPKG

@lbrlabs/pulumi-grafana

Version:

A Pulumi package for creating and managing grafana.

153 lines (152 loc) 5.57 kB
import * as pulumi from "@pulumi/pulumi"; /** * * [HTTP API](https://grafana.com/docs/oncall/latest/oncall-api-reference/outgoing_webhooks/) * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as grafana from "@lbrlabs/pulumi-grafana"; * * const test_acc_outgoingWebhook = new grafana.OncallOutgoingWebhook("test-acc-outgoingWebhook", {url: "https://example.com/"}, { * provider: grafana.oncall, * }); * ``` * * ## Import * * ```sh * $ pulumi import grafana:index/oncallOutgoingWebhook:OncallOutgoingWebhook outgoing_webhook_name {{outgoing_webhook_id}} * ``` */ export declare class OncallOutgoingWebhook extends pulumi.CustomResource { /** * Get an existing OncallOutgoingWebhook 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?: OncallOutgoingWebhookState, opts?: pulumi.CustomResourceOptions): OncallOutgoingWebhook; /** * Returns true if the given object is an instance of OncallOutgoingWebhook. 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 OncallOutgoingWebhook; /** * The auth data of the webhook. Used in Authorization header instead of user/password auth. */ readonly authorizationHeader: pulumi.Output<string | undefined>; /** * The data of the webhook. */ readonly data: pulumi.Output<string | undefined>; /** * Forwards whole payload of the alert to the webhook's url as POST data. */ readonly forwardWholePayload: pulumi.Output<boolean | undefined>; /** * The name of the outgoing webhook. */ readonly name: pulumi.Output<string>; /** * The auth data of the webhook. Used for Basic authentication */ readonly password: pulumi.Output<string | undefined>; /** * 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>; /** * The webhook URL. */ readonly url: pulumi.Output<string>; /** * The auth data of the webhook. Used for Basic authentication. */ readonly user: pulumi.Output<string | undefined>; /** * Create a OncallOutgoingWebhook 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: OncallOutgoingWebhookArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering OncallOutgoingWebhook resources. */ export interface OncallOutgoingWebhookState { /** * The auth data of the webhook. Used in Authorization header instead of user/password auth. */ authorizationHeader?: pulumi.Input<string>; /** * The data of the webhook. */ data?: pulumi.Input<string>; /** * Forwards whole payload of the alert to the webhook's url as POST data. */ forwardWholePayload?: pulumi.Input<boolean>; /** * The name of the outgoing webhook. */ name?: pulumi.Input<string>; /** * The auth data of the webhook. Used for Basic authentication */ password?: 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>; /** * The webhook URL. */ url?: pulumi.Input<string>; /** * The auth data of the webhook. Used for Basic authentication. */ user?: pulumi.Input<string>; } /** * The set of arguments for constructing a OncallOutgoingWebhook resource. */ export interface OncallOutgoingWebhookArgs { /** * The auth data of the webhook. Used in Authorization header instead of user/password auth. */ authorizationHeader?: pulumi.Input<string>; /** * The data of the webhook. */ data?: pulumi.Input<string>; /** * Forwards whole payload of the alert to the webhook's url as POST data. */ forwardWholePayload?: pulumi.Input<boolean>; /** * The name of the outgoing webhook. */ name?: pulumi.Input<string>; /** * The auth data of the webhook. Used for Basic authentication */ password?: 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>; /** * The webhook URL. */ url: pulumi.Input<string>; /** * The auth data of the webhook. Used for Basic authentication. */ user?: pulumi.Input<string>; }