UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

141 lines 5.86 kB
"use strict"; // *** WARNING: this file was generated by pulumi-language-nodejs. *** // *** Do not edit by hand unless you're certain you know what you are doing! *** var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); __setModuleDefault(result, mod); return result; }; Object.defineProperty(exports, "__esModule", { value: true }); exports.getNotificationChannelOutput = exports.getNotificationChannel = void 0; const pulumi = __importStar(require("@pulumi/pulumi")); const utilities = __importStar(require("../utilities")); /** * A NotificationChannel is a medium through which an alert is delivered * when a policy violation is detected. Examples of channels include email, SMS, * and third-party messaging applications. Fields containing sensitive information * like authentication tokens or contact info are only partially populated on retrieval. * * To get more information about NotificationChannel, see: * * * [API documentation](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.notificationChannels) * * How-to Guides * * [Notification Options](https://cloud.google.com/monitoring/support/notification-options) * * [Monitoring API Documentation](https://cloud.google.com/monitoring/api/v3/) * * ## Example Usage * * ### Notification Channel Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const basic = gcp.monitoring.getNotificationChannel({ * displayName: "Test Notification Channel", * }); * const alertPolicy = new gcp.monitoring.AlertPolicy("alert_policy", { * displayName: "My Alert Policy", * notificationChannels: [basic.then(basic => basic.name)], * combiner: "OR", * conditions: [{ * displayName: "test condition", * conditionThreshold: { * filter: "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"", * duration: "60s", * comparison: "COMPARISON_GT", * aggregations: [{ * alignmentPeriod: "60s", * perSeriesAligner: "ALIGN_RATE", * }], * }, * }], * }); * ``` */ function getNotificationChannel(args, opts) { args = args || {}; opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); return pulumi.runtime.invoke("gcp:monitoring/getNotificationChannel:getNotificationChannel", { "displayName": args.displayName, "labels": args.labels, "project": args.project, "type": args.type, "userLabels": args.userLabels, }, opts); } exports.getNotificationChannel = getNotificationChannel; /** * A NotificationChannel is a medium through which an alert is delivered * when a policy violation is detected. Examples of channels include email, SMS, * and third-party messaging applications. Fields containing sensitive information * like authentication tokens or contact info are only partially populated on retrieval. * * To get more information about NotificationChannel, see: * * * [API documentation](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.notificationChannels) * * How-to Guides * * [Notification Options](https://cloud.google.com/monitoring/support/notification-options) * * [Monitoring API Documentation](https://cloud.google.com/monitoring/api/v3/) * * ## Example Usage * * ### Notification Channel Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const basic = gcp.monitoring.getNotificationChannel({ * displayName: "Test Notification Channel", * }); * const alertPolicy = new gcp.monitoring.AlertPolicy("alert_policy", { * displayName: "My Alert Policy", * notificationChannels: [basic.then(basic => basic.name)], * combiner: "OR", * conditions: [{ * displayName: "test condition", * conditionThreshold: { * filter: "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"", * duration: "60s", * comparison: "COMPARISON_GT", * aggregations: [{ * alignmentPeriod: "60s", * perSeriesAligner: "ALIGN_RATE", * }], * }, * }], * }); * ``` */ function getNotificationChannelOutput(args, opts) { args = args || {}; opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); return pulumi.runtime.invokeOutput("gcp:monitoring/getNotificationChannel:getNotificationChannel", { "displayName": args.displayName, "labels": args.labels, "project": args.project, "type": args.type, "userLabels": args.userLabels, }, opts); } exports.getNotificationChannelOutput = getNotificationChannelOutput; //# sourceMappingURL=getNotificationChannel.js.map