AlertPolicyArgs class

The set of arguments for AlertPolicy. The set of arguments for AlertPolicy.

Constructors

AlertPolicyArgs({Input<AlertPolicyAlertStrategy?>? alertStrategy, required Input<String> combiner, required Input<List<AlertPolicyCondition>> conditions, Input<String?>? deletionPolicy, required Input<String> displayName, Input<AlertPolicyDocumentation?>? documentation, Input<bool?>? enabled, Input<List<String>?>? notificationChannels, Input<String?>? project, Input<String?>? severity, Input<Map<String, String>?>? userLabels})
Creates a new AlertPolicyArgs. alertStrategy Control over how this alert policy's notification channels are notified. combiner How to combine the results of multiple conditions to conditions A list of conditions for the policy. The conditions are combined by deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. displayName A short name or phrase used to identify the policy in documentation Documentation that is included with notifications and incidents related enabled Whether or not the policy is enabled. The default is true. notificationChannels Identifies the notification channels to which notifications should be project The ID of the project in which the resource belongs. severity The severity of an alert policy indicates how important incidents generated userLabels This field is intended to be used for organizing and identifying the AlertPolicy
const
AlertPolicyArgs.fromMap(Map<String, dynamic> map)
factory

Properties

alertStrategy → Input<AlertPolicyAlertStrategy?>?
Control over how this alert policy's notification channels are notified. Structure is documented below.
final
combiner → Input<String>
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.
final
conditions → Input<List<AlertPolicyCondition>>
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.
final
deletionPolicy → Input<String?>?
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.
final
displayName → Input<String>
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.
final
documentation → Input<AlertPolicyDocumentation?>?
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.
final
enabled → Input<bool?>?
Whether or not the policy is enabled. The default is true.
final
hashCode → int
The hash code for this object.
no setterinherited
notificationChannels → Input<List<String>?>?
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]
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
severity → Input<String?>?
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.
final
userLabels → Input<Map<String, String>?>?
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited