import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * A description of the conditions under which some aspect of your system is * considered to be "unhealthy" and the ways to notify people or services * about this state. * * To get more information about AlertPolicy, see: * * * [API documentation](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.alertPolicies) * * How-to Guides * * [Official Documentation](https://cloud.google.com/monitoring/alerts/) * * ## Example Usage * * ### Monitoring Alert Policy Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const alertPolicy = new gcp.monitoring.AlertPolicy("alert_policy", { * displayName: "My Alert Policy", * 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", * }], * }, * }], * userLabels: { * foo: "bar", * }, * }); * ``` * ### Monitoring Alert Policy Evaluation Missing Data * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const alertPolicy = new gcp.monitoring.AlertPolicy("alert_policy", { * displayName: "My Alert Policy", * 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", * }], * evaluationMissingData: "EVALUATION_MISSING_DATA_INACTIVE", * }, * }], * userLabels: { * foo: "bar", * }, * }); * ``` * ### Monitoring Alert Policy Forecast Options * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const alertPolicy = new gcp.monitoring.AlertPolicy("alert_policy", { * displayName: "My Alert Policy", * 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", * forecastOptions: { * forecastHorizon: "3600s", * }, * comparison: "COMPARISON_GT", * aggregations: [{ * alignmentPeriod: "60s", * perSeriesAligner: "ALIGN_RATE", * }], * }, * }], * userLabels: { * foo: "bar", * }, * }); * ``` * ### Monitoring Alert Policy Promql Condition * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const alertPolicy = new gcp.monitoring.AlertPolicy("alert_policy", { * displayName: "My Alert Policy", * combiner: "OR", * conditions: [{ * displayName: "test condition", * conditionPrometheusQueryLanguage: { * query: "compute_googleapis_com:instance_cpu_usage_time > 0", * duration: "60s", * evaluationInterval: "60s", * alertRule: "AlwaysOn", * ruleGroup: "a test", * }, * }], * alertStrategy: { * autoClose: "1800s", * }, * }); * ``` * ### Monitoring Alert Policy Sql Condition * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const alertPolicy = new gcp.monitoring.AlertPolicy("alert_policy", { * displayName: "My Alert Policy", * combiner: "OR", * conditions: [{ * displayName: "minutes row count", * conditionSql: { * query: "SELECT severity, resource FROM my_project.global._Default._AllLogs WHERE severity IS NOT NULL", * minutes: { * periodicity: 600, * }, * rowCountTest: { * comparison: "COMPARISON_GT", * threshold: 0, * }, * }, * }], * }); * ``` * * ## Import * * AlertPolicy can be imported using any of these accepted formats: * * * `projects/{{project}}/alertPolicies/{{name}}` * * `{{project}}/{{name}}` * * `{{name}}` * * When using the `pulumi import` command, AlertPolicy can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:monitoring/alertPolicy:AlertPolicy default projects/{{project}}/alertPolicies/{{name}} * $ pulumi import gcp:monitoring/alertPolicy:AlertPolicy default {{project}}/{{name}} * $ pulumi import gcp:monitoring/alertPolicy:AlertPolicy default {{name}} * ``` */ export declare class AlertPolicy extends pulumi.CustomResource { /** * Get an existing AlertPolicy 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, state?: AlertPolicyState, opts?: pulumi.CustomResourceOptions): AlertPolicy; /** * Returns true if the given object is an instance of AlertPolicy. 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 AlertPolicy; /** * Control over how this alert policy's notification channels are notified. * Structure is documented below. */ readonly alertStrategy: pulumi.Output; /** * How to combine the results of multiple conditions to * determine if an incident should be opened. * Possible values are: `AND`, `OR`, `AND_WITH_MATCHING_RESOURCE`. */ readonly combiner: pulumi.Output; /** * A list of conditions for the policy. The conditions are combined by * AND or OR according to the combiner field. If the combined conditions * evaluate to true, then an incident is created. A policy can have from * one to six conditions. * Structure is documented below. */ readonly conditions: pulumi.Output; /** * A read-only record of the creation of the alerting policy. * If provided in a call to create or update, this field will * be ignored. * Structure is documented below. */ readonly creationRecords: pulumi.Output; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ readonly deletionPolicy: pulumi.Output; /** * A short name or phrase used to identify the policy in * dashboards, notifications, and incidents. To avoid confusion, don't use * the same display name for multiple policies in the same project. The * name is limited to 512 Unicode characters. */ readonly displayName: pulumi.Output; /** * Documentation that is included with notifications and incidents related * to this policy. Best practice is for the documentation to include information * to help responders understand, mitigate, escalate, and correct the underlying * problems detected by the alerting policy. Notification channels that have * limited capacity might not show this documentation. * Structure is documented below. */ readonly documentation: pulumi.Output; /** * Whether or not the policy is enabled. The default is true. */ readonly enabled: pulumi.Output; /** * The unique resource name for this policy. * Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] */ readonly name: pulumi.Output; /** * Identifies the notification channels to which notifications should be * sent when incidents are opened or closed or when new violations occur * on an already opened incident. Each element of this array corresponds * to the name field in each of the NotificationChannel objects that are * returned from the notificationChannels.list method. The syntax of the * entries in this field is * `projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]` */ readonly notificationChannels: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The severity of an alert policy indicates how important incidents generated * by that policy are. The severity level will be displayed on the Incident * detail page and in notifications. * Possible values are: `CRITICAL`, `ERROR`, `WARNING`. */ readonly severity: pulumi.Output; /** * This field is intended to be used for organizing and identifying the AlertPolicy * objects.The field can contain up to 64 entries. Each key and value is limited * to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values * can contain only lowercase letters, numerals, underscores, and dashes. Keys * must begin with a letter. */ readonly userLabels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Create a AlertPolicy 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: AlertPolicyArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering AlertPolicy resources. */ export interface AlertPolicyState { /** * Control over how this alert policy's notification channels are notified. * Structure is documented below. */ alertStrategy?: pulumi.Input; /** * How to combine the results of multiple conditions to * determine if an incident should be opened. * Possible values are: `AND`, `OR`, `AND_WITH_MATCHING_RESOURCE`. */ combiner?: pulumi.Input; /** * A list of conditions for the policy. The conditions are combined by * AND or OR according to the combiner field. If the combined conditions * evaluate to true, then an incident is created. A policy can have from * one to six conditions. * Structure is documented below. */ conditions?: pulumi.Input[] | undefined>; /** * A read-only record of the creation of the alerting policy. * If provided in a call to create or update, this field will * be ignored. * Structure is documented below. */ creationRecords?: pulumi.Input[] | undefined>; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input; /** * A short name or phrase used to identify the policy in * dashboards, notifications, and incidents. To avoid confusion, don't use * the same display name for multiple policies in the same project. The * name is limited to 512 Unicode characters. */ displayName?: pulumi.Input; /** * Documentation that is included with notifications and incidents related * to this policy. Best practice is for the documentation to include information * to help responders understand, mitigate, escalate, and correct the underlying * problems detected by the alerting policy. Notification channels that have * limited capacity might not show this documentation. * Structure is documented below. */ documentation?: pulumi.Input; /** * Whether or not the policy is enabled. The default is true. */ enabled?: pulumi.Input; /** * The unique resource name for this policy. * Its syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] */ name?: pulumi.Input; /** * Identifies the notification channels to which notifications should be * sent when incidents are opened or closed or when new violations occur * on an already opened incident. Each element of this array corresponds * to the name field in each of the NotificationChannel objects that are * returned from the notificationChannels.list method. The syntax of the * entries in this field is * `projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]` */ notificationChannels?: pulumi.Input[] | undefined>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The severity of an alert policy indicates how important incidents generated * by that policy are. The severity level will be displayed on the Incident * detail page and in notifications. * Possible values are: `CRITICAL`, `ERROR`, `WARNING`. */ severity?: pulumi.Input; /** * This field is intended to be used for organizing and identifying the AlertPolicy * objects.The field can contain up to 64 entries. Each key and value is limited * to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values * can contain only lowercase letters, numerals, underscores, and dashes. Keys * must begin with a letter. */ userLabels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; } /** * The set of arguments for constructing a AlertPolicy resource. */ export interface AlertPolicyArgs { /** * Control over how this alert policy's notification channels are notified. * Structure is documented below. */ alertStrategy?: pulumi.Input; /** * How to combine the results of multiple conditions to * determine if an incident should be opened. * Possible values are: `AND`, `OR`, `AND_WITH_MATCHING_RESOURCE`. */ combiner: pulumi.Input; /** * A list of conditions for the policy. The conditions are combined by * AND or OR according to the combiner field. If the combined conditions * evaluate to true, then an incident is created. A policy can have from * one to six conditions. * Structure is documented below. */ conditions: pulumi.Input[]>; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input; /** * A short name or phrase used to identify the policy in * dashboards, notifications, and incidents. To avoid confusion, don't use * the same display name for multiple policies in the same project. The * name is limited to 512 Unicode characters. */ displayName: pulumi.Input; /** * Documentation that is included with notifications and incidents related * to this policy. Best practice is for the documentation to include information * to help responders understand, mitigate, escalate, and correct the underlying * problems detected by the alerting policy. Notification channels that have * limited capacity might not show this documentation. * Structure is documented below. */ documentation?: pulumi.Input; /** * Whether or not the policy is enabled. The default is true. */ enabled?: pulumi.Input; /** * Identifies the notification channels to which notifications should be * sent when incidents are opened or closed or when new violations occur * on an already opened incident. Each element of this array corresponds * to the name field in each of the NotificationChannel objects that are * returned from the notificationChannels.list method. The syntax of the * entries in this field is * `projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]` */ notificationChannels?: pulumi.Input[] | undefined>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The severity of an alert policy indicates how important incidents generated * by that policy are. The severity level will be displayed on the Incident * detail page and in notifications. * Possible values are: `CRITICAL`, `ERROR`, `WARNING`. */ severity?: pulumi.Input; /** * This field is intended to be used for organizing and identifying the AlertPolicy * objects.The field can contain up to 64 entries. Each key and value is limited * to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values * can contain only lowercase letters, numerals, underscores, and dashes. Keys * must begin with a letter. */ userLabels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; } //# sourceMappingURL=alertPolicy.d.ts.map