Alarm

class Alarm : KotlinCustomResource

This resource provides a alarm rule resource and it can be used to monitor several cloud services according different metrics. Details for What is alarm.

NOTE: Available since v1.9.1.

Example Usage

Basic Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.ecs.EcsFunctions;
import com.pulumi.alicloud.ecs.inputs.GetImagesArgs;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetZonesArgs;
import com.pulumi.alicloud.ecs.inputs.GetInstanceTypesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.ecs.SecurityGroup;
import com.pulumi.alicloud.ecs.SecurityGroupArgs;
import com.pulumi.alicloud.ecs.Instance;
import com.pulumi.alicloud.ecs.InstanceArgs;
import com.pulumi.alicloud.cms.AlarmContactGroup;
import com.pulumi.alicloud.cms.AlarmContactGroupArgs;
import com.pulumi.alicloud.cms.Alarm;
import com.pulumi.alicloud.cms.AlarmArgs;
import com.pulumi.alicloud.cms.inputs.AlarmEscalationsCriticalArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var name = config.get("name").orElse("tf-example");
final var defaultImages = EcsFunctions.getImages(GetImagesArgs.builder()
.nameRegex("^ubuntu_[0-9]+_[0-9]+_x64*")
.owners("system")
.build());
final var defaultZones = AlicloudFunctions.getZones(GetZonesArgs.builder()
.availableResourceCreation("Instance")
.build());
final var defaultInstanceTypes = EcsFunctions.getInstanceTypes(GetInstanceTypesArgs.builder()
.availabilityZone(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
.cpuCoreCount(1)
.memorySize(2)
.build());
var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
.vpcName(name)
.cidrBlock("10.4.0.0/16")
.build());
var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
.vswitchName(name)
.cidrBlock("10.4.0.0/24")
.vpcId(defaultNetwork.id())
.zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
.build());
var defaultSecurityGroup = new SecurityGroup("defaultSecurityGroup", SecurityGroupArgs.builder()
.vpcId(defaultNetwork.id())
.build());
var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
.availabilityZone(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
.instanceName(name)
.imageId(defaultImages.applyValue(getImagesResult -> getImagesResult.images()[0].id()))
.instanceType(defaultInstanceTypes.applyValue(getInstanceTypesResult -> getInstanceTypesResult.instanceTypes()[0].id()))
.securityGroups(defaultSecurityGroup.id())
.vswitchId(defaultSwitch.id())
.build());
var defaultAlarmContactGroup = new AlarmContactGroup("defaultAlarmContactGroup", AlarmContactGroupArgs.builder()
.alarmContactGroupName(name)
.build());
var defaultAlarm = new Alarm("defaultAlarm", AlarmArgs.builder()
.project("acs_ecs_dashboard")
.metric("disk_writebytes")
.metricDimensions(defaultInstance.id().applyValue(id -> String.format("[{{\"instanceId\":\"%s\",\"device\":\"/dev/vda1\"}}]", id)))
.escalationsCritical(AlarmEscalationsCriticalArgs.builder()
.statistics("Average")
.comparisonOperator("<=")
.threshold(35)
.times(2)
.build())
.period(900)
.contactGroups(defaultAlarmContactGroup.alarmContactGroupName())
.effectiveInterval("06:00-20:00")
.build());
}
}

Import

Alarm rule can be imported using the id, e.g.

$ pulumi import alicloud:cms/alarm:Alarm alarm abc12345

Properties

Link copied to clipboard
val contactGroups: Output<List<String>>

List contact groups of the alarm rule, which must have been created on the console.

Link copied to clipboard
val dimensions: Output<Map<String, Any>>

Field dimensions has been deprecated from version 1.95.0. Use metric_dimensions instead.

Link copied to clipboard

The interval of effecting alarm rule. It format as "hh:mm-hh:mm", like "0:00-4:00". Default to "00:00-23:59".

Link copied to clipboard
val enabled: Output<Boolean>?

Whether to enable alarm rule. Default to true.

Link copied to clipboard
val endTime: Output<Int>?

It has been deprecated from provider version 1.50.0 and 'effective_interval' instead.

Link copied to clipboard

A configuration of critical alarm. See escalations_critical below.

Link copied to clipboard

A configuration of critical info. See escalations_info below.

Link copied to clipboard

A configuration of critical warn. See escalations_warn below.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val metric: Output<String>

Name of the monitoring metrics corresponding to a project, such as "CPUUtilization" and "networkin_rate". For more information, see Metrics Reference.

Link copied to clipboard

Map of the resources associated with the alarm rule, such as "instanceId", "device" and "port". Each key's value is a string, and it uses comma to split multiple items. For more information, see Metrics Reference.

Link copied to clipboard
val name: Output<String>

The alarm rule name.

Link copied to clipboard
val operator: Output<String>

It has been deprecated from provider version 1.94.0 and 'escalations_critical.comparison_operator' instead.

Link copied to clipboard
val period: Output<Int>?

Index query cycle, which must be consistent with that defined for metrics. Default to 300, in seconds.

Link copied to clipboard
val project: Output<String>

Monitor project name, such as "acs_ecs_dashboard" and "acs_rds_dashboard". For more information, see Metrics Reference. NOTE: The dimensions and metric_dimensions must be empty when project is acs_prometheus, otherwise, one of them must be set.

Link copied to clipboard

The Prometheus alert rule. See prometheus below. Note: This parameter is required only when you create a Prometheus alert rule for Hybrid Cloud Monitoring.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val silenceTime: Output<Int>?

Notification silence period in the alarm state, in seconds. Valid value range: 300, 86400. Default to 86400

Link copied to clipboard
val startTime: Output<Int>?

It has been deprecated from provider version 1.50.0 and 'effective_interval' instead.

Link copied to clipboard
val statistics: Output<String>

It has been deprecated from provider version 1.94.0 and 'escalations_critical.statistics' instead.

Link copied to clipboard
val status: Output<String>

The current alarm rule status.

Link copied to clipboard
val tags: Output<Map<String, Any>>?

A mapping of tags to assign to the resource.

Link copied to clipboard
val threshold: Output<String>

It has been deprecated from provider version 1.94.0 and 'escalations_critical.threshold' instead.

Link copied to clipboard
val triggeredCount: Output<Int>

It has been deprecated from provider version 1.94.0 and 'escalations_critical.times' instead.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val webhook: Output<String>?

The webhook that should be called when the alarm is triggered. Currently, only http protocol is supported. Default is empty string.