Docs
PackagesTry AWS Native preview for resources not in the classic version.
aws.cloudwatch.MetricAlarm
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides a CloudWatch Metric Alarm resource.
Example in Conjunction with Scaling Policies
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const batPolicy = new aws.autoscaling.Policy("batPolicy", {
scalingAdjustment: 4,
adjustmentType: "ChangeInCapacity",
cooldown: 300,
autoscalingGroupName: aws_autoscaling_group.bar.name,
});
const batMetricAlarm = new aws.cloudwatch.MetricAlarm("batMetricAlarm", {
comparisonOperator: "GreaterThanOrEqualToThreshold",
evaluationPeriods: 2,
metricName: "CPUUtilization",
namespace: "AWS/EC2",
period: 120,
statistic: "Average",
threshold: 80,
dimensions: {
AutoScalingGroupName: aws_autoscaling_group.bar.name,
},
alarmDescription: "This metric monitors ec2 cpu utilization",
alarmActions: [batPolicy.arn],
});
import pulumi
import pulumi_aws as aws
bat_policy = aws.autoscaling.Policy("batPolicy",
scaling_adjustment=4,
adjustment_type="ChangeInCapacity",
cooldown=300,
autoscaling_group_name=aws_autoscaling_group["bar"]["name"])
bat_metric_alarm = aws.cloudwatch.MetricAlarm("batMetricAlarm",
comparison_operator="GreaterThanOrEqualToThreshold",
evaluation_periods=2,
metric_name="CPUUtilization",
namespace="AWS/EC2",
period=120,
statistic="Average",
threshold=80,
dimensions={
"AutoScalingGroupName": aws_autoscaling_group["bar"]["name"],
},
alarm_description="This metric monitors ec2 cpu utilization",
alarm_actions=[bat_policy.arn])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var batPolicy = new Aws.AutoScaling.Policy("batPolicy", new()
{
ScalingAdjustment = 4,
AdjustmentType = "ChangeInCapacity",
Cooldown = 300,
AutoscalingGroupName = aws_autoscaling_group.Bar.Name,
});
var batMetricAlarm = new Aws.CloudWatch.MetricAlarm("batMetricAlarm", new()
{
ComparisonOperator = "GreaterThanOrEqualToThreshold",
EvaluationPeriods = 2,
MetricName = "CPUUtilization",
Namespace = "AWS/EC2",
Period = 120,
Statistic = "Average",
Threshold = 80,
Dimensions =
{
{ "AutoScalingGroupName", aws_autoscaling_group.Bar.Name },
},
AlarmDescription = "This metric monitors ec2 cpu utilization",
AlarmActions = new[]
{
batPolicy.Arn,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/autoscaling"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
batPolicy, err := autoscaling.NewPolicy(ctx, "batPolicy", &autoscaling.PolicyArgs{
ScalingAdjustment: pulumi.Int(4),
AdjustmentType: pulumi.String("ChangeInCapacity"),
Cooldown: pulumi.Int(300),
AutoscalingGroupName: pulumi.Any(aws_autoscaling_group.Bar.Name),
})
if err != nil {
return err
}
_, err = cloudwatch.NewMetricAlarm(ctx, "batMetricAlarm", &cloudwatch.MetricAlarmArgs{
ComparisonOperator: pulumi.String("GreaterThanOrEqualToThreshold"),
EvaluationPeriods: pulumi.Int(2),
MetricName: pulumi.String("CPUUtilization"),
Namespace: pulumi.String("AWS/EC2"),
Period: pulumi.Int(120),
Statistic: pulumi.String("Average"),
Threshold: pulumi.Float64(80),
Dimensions: pulumi.StringMap{
"AutoScalingGroupName": pulumi.Any(aws_autoscaling_group.Bar.Name),
},
AlarmDescription: pulumi.String("This metric monitors ec2 cpu utilization"),
AlarmActions: pulumi.Array{
batPolicy.Arn,
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.autoscaling.Policy;
import com.pulumi.aws.autoscaling.PolicyArgs;
import com.pulumi.aws.cloudwatch.MetricAlarm;
import com.pulumi.aws.cloudwatch.MetricAlarmArgs;
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) {
var batPolicy = new Policy("batPolicy", PolicyArgs.builder()
.scalingAdjustment(4)
.adjustmentType("ChangeInCapacity")
.cooldown(300)
.autoscalingGroupName(aws_autoscaling_group.bar().name())
.build());
var batMetricAlarm = new MetricAlarm("batMetricAlarm", MetricAlarmArgs.builder()
.comparisonOperator("GreaterThanOrEqualToThreshold")
.evaluationPeriods(2)
.metricName("CPUUtilization")
.namespace("AWS/EC2")
.period(120)
.statistic("Average")
.threshold(80)
.dimensions(Map.of("AutoScalingGroupName", aws_autoscaling_group.bar().name()))
.alarmDescription("This metric monitors ec2 cpu utilization")
.alarmActions(batPolicy.arn())
.build());
}
}
resources:
batPolicy:
type: aws:autoscaling:Policy
properties:
scalingAdjustment: 4
adjustmentType: ChangeInCapacity
cooldown: 300
autoscalingGroupName: ${aws_autoscaling_group.bar.name}
batMetricAlarm:
type: aws:cloudwatch:MetricAlarm
properties:
comparisonOperator: GreaterThanOrEqualToThreshold
evaluationPeriods: 2
metricName: CPUUtilization
namespace: AWS/EC2
period: 120
statistic: Average
threshold: 80
dimensions:
AutoScalingGroupName: ${aws_autoscaling_group.bar.name}
alarmDescription: This metric monitors ec2 cpu utilization
alarmActions:
- ${batPolicy.arn}
Example with an Expression
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foobar = new aws.cloudwatch.MetricAlarm("foobar", {
alarmDescription: "Request error rate has exceeded 10%",
comparisonOperator: "GreaterThanOrEqualToThreshold",
evaluationPeriods: 2,
insufficientDataActions: [],
metricQueries: [
{
expression: "m2/m1*100",
id: "e1",
label: "Error Rate",
returnData: true,
},
{
id: "m1",
metric: {
dimensions: {
LoadBalancer: "app/web",
},
metricName: "RequestCount",
namespace: "AWS/ApplicationELB",
period: 120,
stat: "Sum",
unit: "Count",
},
},
{
id: "m2",
metric: {
dimensions: {
LoadBalancer: "app/web",
},
metricName: "HTTPCode_ELB_5XX_Count",
namespace: "AWS/ApplicationELB",
period: 120,
stat: "Sum",
unit: "Count",
},
},
],
threshold: 10,
});
import pulumi
import pulumi_aws as aws
foobar = aws.cloudwatch.MetricAlarm("foobar",
alarm_description="Request error rate has exceeded 10%",
comparison_operator="GreaterThanOrEqualToThreshold",
evaluation_periods=2,
insufficient_data_actions=[],
metric_queries=[
aws.cloudwatch.MetricAlarmMetricQueryArgs(
expression="m2/m1*100",
id="e1",
label="Error Rate",
return_data=True,
),
aws.cloudwatch.MetricAlarmMetricQueryArgs(
id="m1",
metric=aws.cloudwatch.MetricAlarmMetricQueryMetricArgs(
dimensions={
"LoadBalancer": "app/web",
},
metric_name="RequestCount",
namespace="AWS/ApplicationELB",
period=120,
stat="Sum",
unit="Count",
),
),
aws.cloudwatch.MetricAlarmMetricQueryArgs(
id="m2",
metric=aws.cloudwatch.MetricAlarmMetricQueryMetricArgs(
dimensions={
"LoadBalancer": "app/web",
},
metric_name="HTTPCode_ELB_5XX_Count",
namespace="AWS/ApplicationELB",
period=120,
stat="Sum",
unit="Count",
),
),
],
threshold=10)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var foobar = new Aws.CloudWatch.MetricAlarm("foobar", new()
{
AlarmDescription = "Request error rate has exceeded 10%",
ComparisonOperator = "GreaterThanOrEqualToThreshold",
EvaluationPeriods = 2,
InsufficientDataActions = new[] {},
MetricQueries = new[]
{
new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryArgs
{
Expression = "m2/m1*100",
Id = "e1",
Label = "Error Rate",
ReturnData = true,
},
new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryArgs
{
Id = "m1",
Metric = new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryMetricArgs
{
Dimensions =
{
{ "LoadBalancer", "app/web" },
},
MetricName = "RequestCount",
Namespace = "AWS/ApplicationELB",
Period = 120,
Stat = "Sum",
Unit = "Count",
},
},
new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryArgs
{
Id = "m2",
Metric = new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryMetricArgs
{
Dimensions =
{
{ "LoadBalancer", "app/web" },
},
MetricName = "HTTPCode_ELB_5XX_Count",
Namespace = "AWS/ApplicationELB",
Period = 120,
Stat = "Sum",
Unit = "Count",
},
},
},
Threshold = 10,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudwatch.NewMetricAlarm(ctx, "foobar", &cloudwatch.MetricAlarmArgs{
AlarmDescription: pulumi.String("Request error rate has exceeded 10%"),
ComparisonOperator: pulumi.String("GreaterThanOrEqualToThreshold"),
EvaluationPeriods: pulumi.Int(2),
InsufficientDataActions: pulumi.Array{},
MetricQueries: cloudwatch.MetricAlarmMetricQueryArray{
&cloudwatch.MetricAlarmMetricQueryArgs{
Expression: pulumi.String("m2/m1*100"),
Id: pulumi.String("e1"),
Label: pulumi.String("Error Rate"),
ReturnData: pulumi.Bool(true),
},
&cloudwatch.MetricAlarmMetricQueryArgs{
Id: pulumi.String("m1"),
Metric: &cloudwatch.MetricAlarmMetricQueryMetricArgs{
Dimensions: pulumi.StringMap{
"LoadBalancer": pulumi.String("app/web"),
},
MetricName: pulumi.String("RequestCount"),
Namespace: pulumi.String("AWS/ApplicationELB"),
Period: pulumi.Int(120),
Stat: pulumi.String("Sum"),
Unit: pulumi.String("Count"),
},
},
&cloudwatch.MetricAlarmMetricQueryArgs{
Id: pulumi.String("m2"),
Metric: &cloudwatch.MetricAlarmMetricQueryMetricArgs{
Dimensions: pulumi.StringMap{
"LoadBalancer": pulumi.String("app/web"),
},
MetricName: pulumi.String("HTTPCode_ELB_5XX_Count"),
Namespace: pulumi.String("AWS/ApplicationELB"),
Period: pulumi.Int(120),
Stat: pulumi.String("Sum"),
Unit: pulumi.String("Count"),
},
},
},
Threshold: pulumi.Float64(10),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.MetricAlarm;
import com.pulumi.aws.cloudwatch.MetricAlarmArgs;
import com.pulumi.aws.cloudwatch.inputs.MetricAlarmMetricQueryArgs;
import com.pulumi.aws.cloudwatch.inputs.MetricAlarmMetricQueryMetricArgs;
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) {
var foobar = new MetricAlarm("foobar", MetricAlarmArgs.builder()
.alarmDescription("Request error rate has exceeded 10%")
.comparisonOperator("GreaterThanOrEqualToThreshold")
.evaluationPeriods(2)
.insufficientDataActions()
.metricQueries(
MetricAlarmMetricQueryArgs.builder()
.expression("m2/m1*100")
.id("e1")
.label("Error Rate")
.returnData("true")
.build(),
MetricAlarmMetricQueryArgs.builder()
.id("m1")
.metric(MetricAlarmMetricQueryMetricArgs.builder()
.dimensions(Map.of("LoadBalancer", "app/web"))
.metricName("RequestCount")
.namespace("AWS/ApplicationELB")
.period(120)
.stat("Sum")
.unit("Count")
.build())
.build(),
MetricAlarmMetricQueryArgs.builder()
.id("m2")
.metric(MetricAlarmMetricQueryMetricArgs.builder()
.dimensions(Map.of("LoadBalancer", "app/web"))
.metricName("HTTPCode_ELB_5XX_Count")
.namespace("AWS/ApplicationELB")
.period(120)
.stat("Sum")
.unit("Count")
.build())
.build())
.threshold(10)
.build());
}
}
resources:
foobar:
type: aws:cloudwatch:MetricAlarm
properties:
alarmDescription: Request error rate has exceeded 10%
comparisonOperator: GreaterThanOrEqualToThreshold
evaluationPeriods: 2
insufficientDataActions: []
metricQueries:
- expression: m2/m1*100
id: e1
label: Error Rate
returnData: 'true'
- id: m1
metric:
dimensions:
LoadBalancer: app/web
metricName: RequestCount
namespace: AWS/ApplicationELB
period: 120
stat: Sum
unit: Count
- id: m2
metric:
dimensions:
LoadBalancer: app/web
metricName: HTTPCode_ELB_5XX_Count
namespace: AWS/ApplicationELB
period: 120
stat: Sum
unit: Count
threshold: 10
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const xxAnomalyDetection = new aws.cloudwatch.MetricAlarm("xxAnomalyDetection", {
alarmDescription: "This metric monitors ec2 cpu utilization",
comparisonOperator: "GreaterThanUpperThreshold",
evaluationPeriods: 2,
insufficientDataActions: [],
metricQueries: [
{
expression: "ANOMALY_DETECTION_BAND(m1)",
id: "e1",
label: "CPUUtilization (Expected)",
returnData: true,
},
{
id: "m1",
metric: {
dimensions: {
InstanceId: "i-abc123",
},
metricName: "CPUUtilization",
namespace: "AWS/EC2",
period: 120,
stat: "Average",
unit: "Count",
},
returnData: true,
},
],
thresholdMetricId: "e1",
});
import pulumi
import pulumi_aws as aws
xx_anomaly_detection = aws.cloudwatch.MetricAlarm("xxAnomalyDetection",
alarm_description="This metric monitors ec2 cpu utilization",
comparison_operator="GreaterThanUpperThreshold",
evaluation_periods=2,
insufficient_data_actions=[],
metric_queries=[
aws.cloudwatch.MetricAlarmMetricQueryArgs(
expression="ANOMALY_DETECTION_BAND(m1)",
id="e1",
label="CPUUtilization (Expected)",
return_data=True,
),
aws.cloudwatch.MetricAlarmMetricQueryArgs(
id="m1",
metric=aws.cloudwatch.MetricAlarmMetricQueryMetricArgs(
dimensions={
"InstanceId": "i-abc123",
},
metric_name="CPUUtilization",
namespace="AWS/EC2",
period=120,
stat="Average",
unit="Count",
),
return_data=True,
),
],
threshold_metric_id="e1")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var xxAnomalyDetection = new Aws.CloudWatch.MetricAlarm("xxAnomalyDetection", new()
{
AlarmDescription = "This metric monitors ec2 cpu utilization",
ComparisonOperator = "GreaterThanUpperThreshold",
EvaluationPeriods = 2,
InsufficientDataActions = new[] {},
MetricQueries = new[]
{
new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryArgs
{
Expression = "ANOMALY_DETECTION_BAND(m1)",
Id = "e1",
Label = "CPUUtilization (Expected)",
ReturnData = true,
},
new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryArgs
{
Id = "m1",
Metric = new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryMetricArgs
{
Dimensions =
{
{ "InstanceId", "i-abc123" },
},
MetricName = "CPUUtilization",
Namespace = "AWS/EC2",
Period = 120,
Stat = "Average",
Unit = "Count",
},
ReturnData = true,
},
},
ThresholdMetricId = "e1",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudwatch.NewMetricAlarm(ctx, "xxAnomalyDetection", &cloudwatch.MetricAlarmArgs{
AlarmDescription: pulumi.String("This metric monitors ec2 cpu utilization"),
ComparisonOperator: pulumi.String("GreaterThanUpperThreshold"),
EvaluationPeriods: pulumi.Int(2),
InsufficientDataActions: pulumi.Array{},
MetricQueries: cloudwatch.MetricAlarmMetricQueryArray{
&cloudwatch.MetricAlarmMetricQueryArgs{
Expression: pulumi.String("ANOMALY_DETECTION_BAND(m1)"),
Id: pulumi.String("e1"),
Label: pulumi.String("CPUUtilization (Expected)"),
ReturnData: pulumi.Bool(true),
},
&cloudwatch.MetricAlarmMetricQueryArgs{
Id: pulumi.String("m1"),
Metric: &cloudwatch.MetricAlarmMetricQueryMetricArgs{
Dimensions: pulumi.StringMap{
"InstanceId": pulumi.String("i-abc123"),
},
MetricName: pulumi.String("CPUUtilization"),
Namespace: pulumi.String("AWS/EC2"),
Period: pulumi.Int(120),
Stat: pulumi.String("Average"),
Unit: pulumi.String("Count"),
},
ReturnData: pulumi.Bool(true),
},
},
ThresholdMetricId: pulumi.String("e1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.MetricAlarm;
import com.pulumi.aws.cloudwatch.MetricAlarmArgs;
import com.pulumi.aws.cloudwatch.inputs.MetricAlarmMetricQueryArgs;
import com.pulumi.aws.cloudwatch.inputs.MetricAlarmMetricQueryMetricArgs;
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) {
var xxAnomalyDetection = new MetricAlarm("xxAnomalyDetection", MetricAlarmArgs.builder()
.alarmDescription("This metric monitors ec2 cpu utilization")
.comparisonOperator("GreaterThanUpperThreshold")
.evaluationPeriods(2)
.insufficientDataActions()
.metricQueries(
MetricAlarmMetricQueryArgs.builder()
.expression("ANOMALY_DETECTION_BAND(m1)")
.id("e1")
.label("CPUUtilization (Expected)")
.returnData("true")
.build(),
MetricAlarmMetricQueryArgs.builder()
.id("m1")
.metric(MetricAlarmMetricQueryMetricArgs.builder()
.dimensions(Map.of("InstanceId", "i-abc123"))
.metricName("CPUUtilization")
.namespace("AWS/EC2")
.period(120)
.stat("Average")
.unit("Count")
.build())
.returnData("true")
.build())
.thresholdMetricId("e1")
.build());
}
}
resources:
xxAnomalyDetection:
type: aws:cloudwatch:MetricAlarm
properties:
alarmDescription: This metric monitors ec2 cpu utilization
comparisonOperator: GreaterThanUpperThreshold
evaluationPeriods: 2
insufficientDataActions: []
metricQueries:
- expression: ANOMALY_DETECTION_BAND(m1)
id: e1
label: CPUUtilization (Expected)
returnData: 'true'
- id: m1
metric:
dimensions:
InstanceId: i-abc123
metricName: CPUUtilization
namespace: AWS/EC2
period: 120
stat: Average
unit: Count
returnData: 'true'
thresholdMetricId: e1
Example of monitoring Healthy Hosts on NLB using Target Group and NLB
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const nlbHealthyhosts = new aws.cloudwatch.MetricAlarm("nlbHealthyhosts", {
comparisonOperator: "LessThanThreshold",
evaluationPeriods: 1,
metricName: "HealthyHostCount",
namespace: "AWS/NetworkELB",
period: 60,
statistic: "Average",
threshold: _var.logstash_servers_count,
alarmDescription: "Number of healthy nodes in Target Group",
actionsEnabled: true,
alarmActions: [aws_sns_topic.sns.arn],
okActions: [aws_sns_topic.sns.arn],
dimensions: {
TargetGroup: aws_lb_target_group["lb-tg"].arn_suffix,
LoadBalancer: aws_lb.lb.arn_suffix,
},
});
import pulumi
import pulumi_aws as aws
nlb_healthyhosts = aws.cloudwatch.MetricAlarm("nlbHealthyhosts",
comparison_operator="LessThanThreshold",
evaluation_periods=1,
metric_name="HealthyHostCount",
namespace="AWS/NetworkELB",
period=60,
statistic="Average",
threshold=var["logstash_servers_count"],
alarm_description="Number of healthy nodes in Target Group",
actions_enabled=True,
alarm_actions=[aws_sns_topic["sns"]["arn"]],
ok_actions=[aws_sns_topic["sns"]["arn"]],
dimensions={
"TargetGroup": aws_lb_target_group["lb-tg"]["arn_suffix"],
"LoadBalancer": aws_lb["lb"]["arn_suffix"],
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var nlbHealthyhosts = new Aws.CloudWatch.MetricAlarm("nlbHealthyhosts", new()
{
ComparisonOperator = "LessThanThreshold",
EvaluationPeriods = 1,
MetricName = "HealthyHostCount",
Namespace = "AWS/NetworkELB",
Period = 60,
Statistic = "Average",
Threshold = @var.Logstash_servers_count,
AlarmDescription = "Number of healthy nodes in Target Group",
ActionsEnabled = true,
AlarmActions = new[]
{
aws_sns_topic.Sns.Arn,
},
OkActions = new[]
{
aws_sns_topic.Sns.Arn,
},
Dimensions =
{
{ "TargetGroup", aws_lb_target_group.Lb_tg.Arn_suffix },
{ "LoadBalancer", aws_lb.Lb.Arn_suffix },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudwatch.NewMetricAlarm(ctx, "nlbHealthyhosts", &cloudwatch.MetricAlarmArgs{
ComparisonOperator: pulumi.String("LessThanThreshold"),
EvaluationPeriods: pulumi.Int(1),
MetricName: pulumi.String("HealthyHostCount"),
Namespace: pulumi.String("AWS/NetworkELB"),
Period: pulumi.Int(60),
Statistic: pulumi.String("Average"),
Threshold: pulumi.Any(_var.Logstash_servers_count),
AlarmDescription: pulumi.String("Number of healthy nodes in Target Group"),
ActionsEnabled: pulumi.Bool(true),
AlarmActions: pulumi.Array{
aws_sns_topic.Sns.Arn,
},
OkActions: pulumi.Array{
aws_sns_topic.Sns.Arn,
},
Dimensions: pulumi.StringMap{
"TargetGroup": pulumi.Any(aws_lb_target_group.LbTg.Arn_suffix),
"LoadBalancer": pulumi.Any(aws_lb.Lb.Arn_suffix),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.MetricAlarm;
import com.pulumi.aws.cloudwatch.MetricAlarmArgs;
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) {
var nlbHealthyhosts = new MetricAlarm("nlbHealthyhosts", MetricAlarmArgs.builder()
.comparisonOperator("LessThanThreshold")
.evaluationPeriods(1)
.metricName("HealthyHostCount")
.namespace("AWS/NetworkELB")
.period(60)
.statistic("Average")
.threshold(var_.logstash_servers_count())
.alarmDescription("Number of healthy nodes in Target Group")
.actionsEnabled("true")
.alarmActions(aws_sns_topic.sns().arn())
.okActions(aws_sns_topic.sns().arn())
.dimensions(Map.ofEntries(
Map.entry("TargetGroup", aws_lb_target_group.lb-tg().arn_suffix()),
Map.entry("LoadBalancer", aws_lb.lb().arn_suffix())
))
.build());
}
}
resources:
nlbHealthyhosts:
type: aws:cloudwatch:MetricAlarm
properties:
comparisonOperator: LessThanThreshold
evaluationPeriods: 1
metricName: HealthyHostCount
namespace: AWS/NetworkELB
period: 60
statistic: Average
threshold: ${var.logstash_servers_count}
alarmDescription: Number of healthy nodes in Target Group
actionsEnabled: 'true'
alarmActions:
- ${aws_sns_topic.sns.arn}
okActions:
- ${aws_sns_topic.sns.arn}
dimensions:
TargetGroup: ${aws_lb_target_group"lb-tg"[%!s(MISSING)].arn_suffix}
LoadBalancer: ${aws_lb.lb.arn_suffix}
NOTE: You cannot create a metric alarm consisting of both
statisticandextended_statisticparameters. You must choose one or the other
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var foobar = new Aws.CloudWatch.MetricAlarm("foobar", new()
{
AlarmDescription = "This metric monitors ec2 cpu utilization",
ComparisonOperator = "GreaterThanOrEqualToThreshold",
EvaluationPeriods = 2,
InsufficientDataActions = new[] {},
MetricName = "CPUUtilization",
Namespace = "AWS/EC2",
Period = 120,
Statistic = "Average",
Threshold = 80,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudwatch.NewMetricAlarm(ctx, "foobar", &cloudwatch.MetricAlarmArgs{
AlarmDescription: pulumi.String("This metric monitors ec2 cpu utilization"),
ComparisonOperator: pulumi.String("GreaterThanOrEqualToThreshold"),
EvaluationPeriods: pulumi.Int(2),
InsufficientDataActions: pulumi.Array{},
MetricName: pulumi.String("CPUUtilization"),
Namespace: pulumi.String("AWS/EC2"),
Period: pulumi.Int(120),
Statistic: pulumi.String("Average"),
Threshold: pulumi.Float64(80),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.MetricAlarm;
import com.pulumi.aws.cloudwatch.MetricAlarmArgs;
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) {
var foobar = new MetricAlarm("foobar", MetricAlarmArgs.builder()
.alarmDescription("This metric monitors ec2 cpu utilization")
.comparisonOperator("GreaterThanOrEqualToThreshold")
.evaluationPeriods(2)
.insufficientDataActions()
.metricName("CPUUtilization")
.namespace("AWS/EC2")
.period(120)
.statistic("Average")
.threshold(80)
.build());
}
}
import pulumi
import pulumi_aws as aws
foobar = aws.cloudwatch.MetricAlarm("foobar",
alarm_description="This metric monitors ec2 cpu utilization",
comparison_operator="GreaterThanOrEqualToThreshold",
evaluation_periods=2,
insufficient_data_actions=[],
metric_name="CPUUtilization",
namespace="AWS/EC2",
period=120,
statistic="Average",
threshold=80)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foobar = new aws.cloudwatch.MetricAlarm("foobar", {
alarmDescription: "This metric monitors ec2 cpu utilization",
comparisonOperator: "GreaterThanOrEqualToThreshold",
evaluationPeriods: 2,
insufficientDataActions: [],
metricName: "CPUUtilization",
namespace: "AWS/EC2",
period: 120,
statistic: "Average",
threshold: 80,
});
resources:
foobar:
type: aws:cloudwatch:MetricAlarm
properties:
alarmDescription: This metric monitors ec2 cpu utilization
comparisonOperator: GreaterThanOrEqualToThreshold
evaluationPeriods: 2
insufficientDataActions: []
metricName: CPUUtilization
namespace: AWS/EC2
period: 120
statistic: Average
threshold: 80
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var batPolicy = new Aws.AutoScaling.Policy("batPolicy", new()
{
ScalingAdjustment = 4,
AdjustmentType = "ChangeInCapacity",
Cooldown = 300,
AutoscalingGroupName = aws_autoscaling_group.Bar.Name,
});
var batMetricAlarm = new Aws.CloudWatch.MetricAlarm("batMetricAlarm", new()
{
ComparisonOperator = "GreaterThanOrEqualToThreshold",
EvaluationPeriods = 2,
MetricName = "CPUUtilization",
Namespace = "AWS/EC2",
Period = 120,
Statistic = "Average",
Threshold = 80,
Dimensions =
{
{ "AutoScalingGroupName", aws_autoscaling_group.Bar.Name },
},
AlarmDescription = "This metric monitors ec2 cpu utilization",
AlarmActions = new[]
{
batPolicy.Arn,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/autoscaling"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
batPolicy, err := autoscaling.NewPolicy(ctx, "batPolicy", &autoscaling.PolicyArgs{
ScalingAdjustment: pulumi.Int(4),
AdjustmentType: pulumi.String("ChangeInCapacity"),
Cooldown: pulumi.Int(300),
AutoscalingGroupName: pulumi.Any(aws_autoscaling_group.Bar.Name),
})
if err != nil {
return err
}
_, err = cloudwatch.NewMetricAlarm(ctx, "batMetricAlarm", &cloudwatch.MetricAlarmArgs{
ComparisonOperator: pulumi.String("GreaterThanOrEqualToThreshold"),
EvaluationPeriods: pulumi.Int(2),
MetricName: pulumi.String("CPUUtilization"),
Namespace: pulumi.String("AWS/EC2"),
Period: pulumi.Int(120),
Statistic: pulumi.String("Average"),
Threshold: pulumi.Float64(80),
Dimensions: pulumi.StringMap{
"AutoScalingGroupName": pulumi.Any(aws_autoscaling_group.Bar.Name),
},
AlarmDescription: pulumi.String("This metric monitors ec2 cpu utilization"),
AlarmActions: pulumi.Array{
batPolicy.Arn,
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.autoscaling.Policy;
import com.pulumi.aws.autoscaling.PolicyArgs;
import com.pulumi.aws.cloudwatch.MetricAlarm;
import com.pulumi.aws.cloudwatch.MetricAlarmArgs;
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) {
var batPolicy = new Policy("batPolicy", PolicyArgs.builder()
.scalingAdjustment(4)
.adjustmentType("ChangeInCapacity")
.cooldown(300)
.autoscalingGroupName(aws_autoscaling_group.bar().name())
.build());
var batMetricAlarm = new MetricAlarm("batMetricAlarm", MetricAlarmArgs.builder()
.comparisonOperator("GreaterThanOrEqualToThreshold")
.evaluationPeriods(2)
.metricName("CPUUtilization")
.namespace("AWS/EC2")
.period(120)
.statistic("Average")
.threshold(80)
.dimensions(Map.of("AutoScalingGroupName", aws_autoscaling_group.bar().name()))
.alarmDescription("This metric monitors ec2 cpu utilization")
.alarmActions(batPolicy.arn())
.build());
}
}
import pulumi
import pulumi_aws as aws
bat_policy = aws.autoscaling.Policy("batPolicy",
scaling_adjustment=4,
adjustment_type="ChangeInCapacity",
cooldown=300,
autoscaling_group_name=aws_autoscaling_group["bar"]["name"])
bat_metric_alarm = aws.cloudwatch.MetricAlarm("batMetricAlarm",
comparison_operator="GreaterThanOrEqualToThreshold",
evaluation_periods=2,
metric_name="CPUUtilization",
namespace="AWS/EC2",
period=120,
statistic="Average",
threshold=80,
dimensions={
"AutoScalingGroupName": aws_autoscaling_group["bar"]["name"],
},
alarm_description="This metric monitors ec2 cpu utilization",
alarm_actions=[bat_policy.arn])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const batPolicy = new aws.autoscaling.Policy("batPolicy", {
scalingAdjustment: 4,
adjustmentType: "ChangeInCapacity",
cooldown: 300,
autoscalingGroupName: aws_autoscaling_group.bar.name,
});
const batMetricAlarm = new aws.cloudwatch.MetricAlarm("batMetricAlarm", {
comparisonOperator: "GreaterThanOrEqualToThreshold",
evaluationPeriods: 2,
metricName: "CPUUtilization",
namespace: "AWS/EC2",
period: 120,
statistic: "Average",
threshold: 80,
dimensions: {
AutoScalingGroupName: aws_autoscaling_group.bar.name,
},
alarmDescription: "This metric monitors ec2 cpu utilization",
alarmActions: [batPolicy.arn],
});
resources:
batPolicy:
type: aws:autoscaling:Policy
properties:
scalingAdjustment: 4
adjustmentType: ChangeInCapacity
cooldown: 300
autoscalingGroupName: ${aws_autoscaling_group.bar.name}
batMetricAlarm:
type: aws:cloudwatch:MetricAlarm
properties:
comparisonOperator: GreaterThanOrEqualToThreshold
evaluationPeriods: 2
metricName: CPUUtilization
namespace: AWS/EC2
period: 120
statistic: Average
threshold: 80
dimensions:
AutoScalingGroupName: ${aws_autoscaling_group.bar.name}
alarmDescription: This metric monitors ec2 cpu utilization
alarmActions:
- ${batPolicy.arn}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var foobar = new Aws.CloudWatch.MetricAlarm("foobar", new()
{
AlarmDescription = "Request error rate has exceeded 10%",
ComparisonOperator = "GreaterThanOrEqualToThreshold",
EvaluationPeriods = 2,
InsufficientDataActions = new[] {},
MetricQueries = new[]
{
new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryArgs
{
Expression = "m2/m1*100",
Id = "e1",
Label = "Error Rate",
ReturnData = true,
},
new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryArgs
{
Id = "m1",
Metric = new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryMetricArgs
{
Dimensions =
{
{ "LoadBalancer", "app/web" },
},
MetricName = "RequestCount",
Namespace = "AWS/ApplicationELB",
Period = 120,
Stat = "Sum",
Unit = "Count",
},
},
new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryArgs
{
Id = "m2",
Metric = new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryMetricArgs
{
Dimensions =
{
{ "LoadBalancer", "app/web" },
},
MetricName = "HTTPCode_ELB_5XX_Count",
Namespace = "AWS/ApplicationELB",
Period = 120,
Stat = "Sum",
Unit = "Count",
},
},
},
Threshold = 10,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudwatch.NewMetricAlarm(ctx, "foobar", &cloudwatch.MetricAlarmArgs{
AlarmDescription: pulumi.String("Request error rate has exceeded 10%"),
ComparisonOperator: pulumi.String("GreaterThanOrEqualToThreshold"),
EvaluationPeriods: pulumi.Int(2),
InsufficientDataActions: pulumi.Array{},
MetricQueries: cloudwatch.MetricAlarmMetricQueryArray{
&cloudwatch.MetricAlarmMetricQueryArgs{
Expression: pulumi.String("m2/m1*100"),
Id: pulumi.String("e1"),
Label: pulumi.String("Error Rate"),
ReturnData: pulumi.Bool(true),
},
&cloudwatch.MetricAlarmMetricQueryArgs{
Id: pulumi.String("m1"),
Metric: &cloudwatch.MetricAlarmMetricQueryMetricArgs{
Dimensions: pulumi.StringMap{
"LoadBalancer": pulumi.String("app/web"),
},
MetricName: pulumi.String("RequestCount"),
Namespace: pulumi.String("AWS/ApplicationELB"),
Period: pulumi.Int(120),
Stat: pulumi.String("Sum"),
Unit: pulumi.String("Count"),
},
},
&cloudwatch.MetricAlarmMetricQueryArgs{
Id: pulumi.String("m2"),
Metric: &cloudwatch.MetricAlarmMetricQueryMetricArgs{
Dimensions: pulumi.StringMap{
"LoadBalancer": pulumi.String("app/web"),
},
MetricName: pulumi.String("HTTPCode_ELB_5XX_Count"),
Namespace: pulumi.String("AWS/ApplicationELB"),
Period: pulumi.Int(120),
Stat: pulumi.String("Sum"),
Unit: pulumi.String("Count"),
},
},
},
Threshold: pulumi.Float64(10),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.MetricAlarm;
import com.pulumi.aws.cloudwatch.MetricAlarmArgs;
import com.pulumi.aws.cloudwatch.inputs.MetricAlarmMetricQueryArgs;
import com.pulumi.aws.cloudwatch.inputs.MetricAlarmMetricQueryMetricArgs;
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) {
var foobar = new MetricAlarm("foobar", MetricAlarmArgs.builder()
.alarmDescription("Request error rate has exceeded 10%")
.comparisonOperator("GreaterThanOrEqualToThreshold")
.evaluationPeriods(2)
.insufficientDataActions()
.metricQueries(
MetricAlarmMetricQueryArgs.builder()
.expression("m2/m1*100")
.id("e1")
.label("Error Rate")
.returnData("true")
.build(),
MetricAlarmMetricQueryArgs.builder()
.id("m1")
.metric(MetricAlarmMetricQueryMetricArgs.builder()
.dimensions(Map.of("LoadBalancer", "app/web"))
.metricName("RequestCount")
.namespace("AWS/ApplicationELB")
.period(120)
.stat("Sum")
.unit("Count")
.build())
.build(),
MetricAlarmMetricQueryArgs.builder()
.id("m2")
.metric(MetricAlarmMetricQueryMetricArgs.builder()
.dimensions(Map.of("LoadBalancer", "app/web"))
.metricName("HTTPCode_ELB_5XX_Count")
.namespace("AWS/ApplicationELB")
.period(120)
.stat("Sum")
.unit("Count")
.build())
.build())
.threshold(10)
.build());
}
}
import pulumi
import pulumi_aws as aws
foobar = aws.cloudwatch.MetricAlarm("foobar",
alarm_description="Request error rate has exceeded 10%",
comparison_operator="GreaterThanOrEqualToThreshold",
evaluation_periods=2,
insufficient_data_actions=[],
metric_queries=[
aws.cloudwatch.MetricAlarmMetricQueryArgs(
expression="m2/m1*100",
id="e1",
label="Error Rate",
return_data=True,
),
aws.cloudwatch.MetricAlarmMetricQueryArgs(
id="m1",
metric=aws.cloudwatch.MetricAlarmMetricQueryMetricArgs(
dimensions={
"LoadBalancer": "app/web",
},
metric_name="RequestCount",
namespace="AWS/ApplicationELB",
period=120,
stat="Sum",
unit="Count",
),
),
aws.cloudwatch.MetricAlarmMetricQueryArgs(
id="m2",
metric=aws.cloudwatch.MetricAlarmMetricQueryMetricArgs(
dimensions={
"LoadBalancer": "app/web",
},
metric_name="HTTPCode_ELB_5XX_Count",
namespace="AWS/ApplicationELB",
period=120,
stat="Sum",
unit="Count",
),
),
],
threshold=10)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foobar = new aws.cloudwatch.MetricAlarm("foobar", {
alarmDescription: "Request error rate has exceeded 10%",
comparisonOperator: "GreaterThanOrEqualToThreshold",
evaluationPeriods: 2,
insufficientDataActions: [],
metricQueries: [
{
expression: "m2/m1*100",
id: "e1",
label: "Error Rate",
returnData: true,
},
{
id: "m1",
metric: {
dimensions: {
LoadBalancer: "app/web",
},
metricName: "RequestCount",
namespace: "AWS/ApplicationELB",
period: 120,
stat: "Sum",
unit: "Count",
},
},
{
id: "m2",
metric: {
dimensions: {
LoadBalancer: "app/web",
},
metricName: "HTTPCode_ELB_5XX_Count",
namespace: "AWS/ApplicationELB",
period: 120,
stat: "Sum",
unit: "Count",
},
},
],
threshold: 10,
});
resources:
foobar:
type: aws:cloudwatch:MetricAlarm
properties:
alarmDescription: Request error rate has exceeded 10%
comparisonOperator: GreaterThanOrEqualToThreshold
evaluationPeriods: 2
insufficientDataActions: []
metricQueries:
- expression: m2/m1*100
id: e1
label: Error Rate
returnData: 'true'
- id: m1
metric:
dimensions:
LoadBalancer: app/web
metricName: RequestCount
namespace: AWS/ApplicationELB
period: 120
stat: Sum
unit: Count
- id: m2
metric:
dimensions:
LoadBalancer: app/web
metricName: HTTPCode_ELB_5XX_Count
namespace: AWS/ApplicationELB
period: 120
stat: Sum
unit: Count
threshold: 10
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var xxAnomalyDetection = new Aws.CloudWatch.MetricAlarm("xxAnomalyDetection", new()
{
AlarmDescription = "This metric monitors ec2 cpu utilization",
ComparisonOperator = "GreaterThanUpperThreshold",
EvaluationPeriods = 2,
InsufficientDataActions = new[] {},
MetricQueries = new[]
{
new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryArgs
{
Expression = "ANOMALY_DETECTION_BAND(m1)",
Id = "e1",
Label = "CPUUtilization (Expected)",
ReturnData = true,
},
new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryArgs
{
Id = "m1",
Metric = new Aws.CloudWatch.Inputs.MetricAlarmMetricQueryMetricArgs
{
Dimensions =
{
{ "InstanceId", "i-abc123" },
},
MetricName = "CPUUtilization",
Namespace = "AWS/EC2",
Period = 120,
Stat = "Average",
Unit = "Count",
},
ReturnData = true,
},
},
ThresholdMetricId = "e1",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudwatch.NewMetricAlarm(ctx, "xxAnomalyDetection", &cloudwatch.MetricAlarmArgs{
AlarmDescription: pulumi.String("This metric monitors ec2 cpu utilization"),
ComparisonOperator: pulumi.String("GreaterThanUpperThreshold"),
EvaluationPeriods: pulumi.Int(2),
InsufficientDataActions: pulumi.Array{},
MetricQueries: cloudwatch.MetricAlarmMetricQueryArray{
&cloudwatch.MetricAlarmMetricQueryArgs{
Expression: pulumi.String("ANOMALY_DETECTION_BAND(m1)"),
Id: pulumi.String("e1"),
Label: pulumi.String("CPUUtilization (Expected)"),
ReturnData: pulumi.Bool(true),
},
&cloudwatch.MetricAlarmMetricQueryArgs{
Id: pulumi.String("m1"),
Metric: &cloudwatch.MetricAlarmMetricQueryMetricArgs{
Dimensions: pulumi.StringMap{
"InstanceId": pulumi.String("i-abc123"),
},
MetricName: pulumi.String("CPUUtilization"),
Namespace: pulumi.String("AWS/EC2"),
Period: pulumi.Int(120),
Stat: pulumi.String("Average"),
Unit: pulumi.String("Count"),
},
ReturnData: pulumi.Bool(true),
},
},
ThresholdMetricId: pulumi.String("e1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.MetricAlarm;
import com.pulumi.aws.cloudwatch.MetricAlarmArgs;
import com.pulumi.aws.cloudwatch.inputs.MetricAlarmMetricQueryArgs;
import com.pulumi.aws.cloudwatch.inputs.MetricAlarmMetricQueryMetricArgs;
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) {
var xxAnomalyDetection = new MetricAlarm("xxAnomalyDetection", MetricAlarmArgs.builder()
.alarmDescription("This metric monitors ec2 cpu utilization")
.comparisonOperator("GreaterThanUpperThreshold")
.evaluationPeriods(2)
.insufficientDataActions()
.metricQueries(
MetricAlarmMetricQueryArgs.builder()
.expression("ANOMALY_DETECTION_BAND(m1)")
.id("e1")
.label("CPUUtilization (Expected)")
.returnData("true")
.build(),
MetricAlarmMetricQueryArgs.builder()
.id("m1")
.metric(MetricAlarmMetricQueryMetricArgs.builder()
.dimensions(Map.of("InstanceId", "i-abc123"))
.metricName("CPUUtilization")
.namespace("AWS/EC2")
.period(120)
.stat("Average")
.unit("Count")
.build())
.returnData("true")
.build())
.thresholdMetricId("e1")
.build());
}
}
import pulumi
import pulumi_aws as aws
xx_anomaly_detection = aws.cloudwatch.MetricAlarm("xxAnomalyDetection",
alarm_description="This metric monitors ec2 cpu utilization",
comparison_operator="GreaterThanUpperThreshold",
evaluation_periods=2,
insufficient_data_actions=[],
metric_queries=[
aws.cloudwatch.MetricAlarmMetricQueryArgs(
expression="ANOMALY_DETECTION_BAND(m1)",
id="e1",
label="CPUUtilization (Expected)",
return_data=True,
),
aws.cloudwatch.MetricAlarmMetricQueryArgs(
id="m1",
metric=aws.cloudwatch.MetricAlarmMetricQueryMetricArgs(
dimensions={
"InstanceId": "i-abc123",
},
metric_name="CPUUtilization",
namespace="AWS/EC2",
period=120,
stat="Average",
unit="Count",
),
return_data=True,
),
],
threshold_metric_id="e1")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const xxAnomalyDetection = new aws.cloudwatch.MetricAlarm("xxAnomalyDetection", {
alarmDescription: "This metric monitors ec2 cpu utilization",
comparisonOperator: "GreaterThanUpperThreshold",
evaluationPeriods: 2,
insufficientDataActions: [],
metricQueries: [
{
expression: "ANOMALY_DETECTION_BAND(m1)",
id: "e1",
label: "CPUUtilization (Expected)",
returnData: true,
},
{
id: "m1",
metric: {
dimensions: {
InstanceId: "i-abc123",
},
metricName: "CPUUtilization",
namespace: "AWS/EC2",
period: 120,
stat: "Average",
unit: "Count",
},
returnData: true,
},
],
thresholdMetricId: "e1",
});
resources:
xxAnomalyDetection:
type: aws:cloudwatch:MetricAlarm
properties:
alarmDescription: This metric monitors ec2 cpu utilization
comparisonOperator: GreaterThanUpperThreshold
evaluationPeriods: 2
insufficientDataActions: []
metricQueries:
- expression: ANOMALY_DETECTION_BAND(m1)
id: e1
label: CPUUtilization (Expected)
returnData: 'true'
- id: m1
metric:
dimensions:
InstanceId: i-abc123
metricName: CPUUtilization
namespace: AWS/EC2
period: 120
stat: Average
unit: Count
returnData: 'true'
thresholdMetricId: e1
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var nlbHealthyhosts = new Aws.CloudWatch.MetricAlarm("nlbHealthyhosts", new()
{
ComparisonOperator = "LessThanThreshold",
EvaluationPeriods = 1,
MetricName = "HealthyHostCount",
Namespace = "AWS/NetworkELB",
Period = 60,
Statistic = "Average",
Threshold = @var.Logstash_servers_count,
AlarmDescription = "Number of healthy nodes in Target Group",
ActionsEnabled = true,
AlarmActions = new[]
{
aws_sns_topic.Sns.Arn,
},
OkActions = new[]
{
aws_sns_topic.Sns.Arn,
},
Dimensions =
{
{ "TargetGroup", aws_lb_target_group.Lb_tg.Arn_suffix },
{ "LoadBalancer", aws_lb.Lb.Arn_suffix },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudwatch.NewMetricAlarm(ctx, "nlbHealthyhosts", &cloudwatch.MetricAlarmArgs{
ComparisonOperator: pulumi.String("LessThanThreshold"),
EvaluationPeriods: pulumi.Int(1),
MetricName: pulumi.String("HealthyHostCount"),
Namespace: pulumi.String("AWS/NetworkELB"),
Period: pulumi.Int(60),
Statistic: pulumi.String("Average"),
Threshold: pulumi.Any(_var.Logstash_servers_count),
AlarmDescription: pulumi.String("Number of healthy nodes in Target Group"),
ActionsEnabled: pulumi.Bool(true),
AlarmActions: pulumi.Array{
aws_sns_topic.Sns.Arn,
},
OkActions: pulumi.Array{
aws_sns_topic.Sns.Arn,
},
Dimensions: pulumi.StringMap{
"TargetGroup": pulumi.Any(aws_lb_target_group.LbTg.Arn_suffix),
"LoadBalancer": pulumi.Any(aws_lb.Lb.Arn_suffix),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.MetricAlarm;
import com.pulumi.aws.cloudwatch.MetricAlarmArgs;
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) {
var nlbHealthyhosts = new MetricAlarm("nlbHealthyhosts", MetricAlarmArgs.builder()
.comparisonOperator("LessThanThreshold")
.evaluationPeriods(1)
.metricName("HealthyHostCount")
.namespace("AWS/NetworkELB")
.period(60)
.statistic("Average")
.threshold(var_.logstash_servers_count())
.alarmDescription("Number of healthy nodes in Target Group")
.actionsEnabled("true")
.alarmActions(aws_sns_topic.sns().arn())
.okActions(aws_sns_topic.sns().arn())
.dimensions(Map.ofEntries(
Map.entry("TargetGroup", aws_lb_target_group.lb-tg().arn_suffix()),
Map.entry("LoadBalancer", aws_lb.lb().arn_suffix())
))
.build());
}
}
import pulumi
import pulumi_aws as aws
nlb_healthyhosts = aws.cloudwatch.MetricAlarm("nlbHealthyhosts",
comparison_operator="LessThanThreshold",
evaluation_periods=1,
metric_name="HealthyHostCount",
namespace="AWS/NetworkELB",
period=60,
statistic="Average",
threshold=var["logstash_servers_count"],
alarm_description="Number of healthy nodes in Target Group",
actions_enabled=True,
alarm_actions=[aws_sns_topic["sns"]["arn"]],
ok_actions=[aws_sns_topic["sns"]["arn"]],
dimensions={
"TargetGroup": aws_lb_target_group["lb-tg"]["arn_suffix"],
"LoadBalancer": aws_lb["lb"]["arn_suffix"],
})
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const nlbHealthyhosts = new aws.cloudwatch.MetricAlarm("nlbHealthyhosts", {
comparisonOperator: "LessThanThreshold",
evaluationPeriods: 1,
metricName: "HealthyHostCount",
namespace: "AWS/NetworkELB",
period: 60,
statistic: "Average",
threshold: _var.logstash_servers_count,
alarmDescription: "Number of healthy nodes in Target Group",
actionsEnabled: true,
alarmActions: [aws_sns_topic.sns.arn],
okActions: [aws_sns_topic.sns.arn],
dimensions: {
TargetGroup: aws_lb_target_group["lb-tg"].arn_suffix,
LoadBalancer: aws_lb.lb.arn_suffix,
},
});
resources:
nlbHealthyhosts:
type: aws:cloudwatch:MetricAlarm
properties:
comparisonOperator: LessThanThreshold
evaluationPeriods: 1
metricName: HealthyHostCount
namespace: AWS/NetworkELB
period: 60
statistic: Average
threshold: ${var.logstash_servers_count}
alarmDescription: Number of healthy nodes in Target Group
actionsEnabled: 'true'
alarmActions:
- ${aws_sns_topic.sns.arn}
okActions:
- ${aws_sns_topic.sns.arn}
dimensions:
TargetGroup: ${aws_lb_target_group"lb-tg"[%!s(MISSING)].arn_suffix}
LoadBalancer: ${aws_lb.lb.arn_suffix}
Create MetricAlarm Resource
new MetricAlarm(name: string, args: MetricAlarmArgs, opts?: CustomResourceOptions);@overload
def MetricAlarm(resource_name: str,
opts: Optional[ResourceOptions] = None,
actions_enabled: Optional[bool] = None,
alarm_actions: Optional[Sequence[str]] = None,
alarm_description: Optional[str] = None,
comparison_operator: Optional[str] = None,
datapoints_to_alarm: Optional[int] = None,
dimensions: Optional[Mapping[str, str]] = None,
evaluate_low_sample_count_percentiles: Optional[str] = None,
evaluation_periods: Optional[int] = None,
extended_statistic: Optional[str] = None,
insufficient_data_actions: Optional[Sequence[str]] = None,
metric_name: Optional[str] = None,
metric_queries: Optional[Sequence[MetricAlarmMetricQueryArgs]] = None,
name: Optional[str] = None,
namespace: Optional[str] = None,
ok_actions: Optional[Sequence[str]] = None,
period: Optional[int] = None,
statistic: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
threshold: Optional[float] = None,
threshold_metric_id: Optional[str] = None,
treat_missing_data: Optional[str] = None,
unit: Optional[str] = None)
@overload
def MetricAlarm(resource_name: str,
args: MetricAlarmArgs,
opts: Optional[ResourceOptions] = None)func NewMetricAlarm(ctx *Context, name string, args MetricAlarmArgs, opts ...ResourceOption) (*MetricAlarm, error)public MetricAlarm(string name, MetricAlarmArgs args, CustomResourceOptions? opts = null)
public MetricAlarm(String name, MetricAlarmArgs args)
public MetricAlarm(String name, MetricAlarmArgs args, CustomResourceOptions options)
type: aws:cloudwatch:MetricAlarm
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MetricAlarmArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args MetricAlarmArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args MetricAlarmArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MetricAlarmArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MetricAlarmArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
MetricAlarm Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The MetricAlarm resource accepts the following input properties:
- Comparison
Operator string The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported:
GreaterThanOrEqualToThreshold,GreaterThanThreshold,LessThanThreshold,LessThanOrEqualToThreshold. Additionally, the valuesLessThanLowerOrGreaterThanUpperThreshold,LessThanLowerThreshold, andGreaterThanUpperThresholdare used only for alarms based on anomaly detection models.- Evaluation
Periods int The number of periods over which data is compared to the specified threshold.
- Actions
Enabled bool Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to
true.- Alarm
Actions List<string> The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- Alarm
Description string The description for the alarm.
- Datapoints
To intAlarm The number of datapoints that must be breaching to trigger the alarm.
- Dimensions Dictionary<string, string>
The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here.
- Evaluate
Low stringSample Count Percentiles Used only for alarms based on percentiles. If you specify
ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specifyevaluateor omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported:ignore, andevaluate.- Extended
Statistic string The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
- Insufficient
Data List<string>Actions The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- Metric
Name string The name for the alarm's associated metric. See docs for supported metrics.
- Metric
Queries List<MetricAlarm Metric Query> Enables you to create an alarm based on a metric math expression. You may specify at most 20.
- Name string
The descriptive name for the alarm. This name must be unique within the user's AWS account
- Namespace string
The namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.
- Ok
Actions List<string> The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- Period int
The period in seconds over which the specified
statisticis applied. Valid values are10,30, or any multiple of60.- Statistic string
The statistic to apply to the alarm's associated metric. Either of the following is supported:
SampleCount,Average,Sum,Minimum,Maximum- Dictionary<string, string>
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.NOTE: If you specify at least one
metric_query, you may not specify ametric_name,namespace,periodorstatistic. If you do not specify ametric_query, you must specify each of these (although you may useextended_statisticinstead ofstatistic).- Threshold double
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
- Threshold
Metric stringId If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
- Treat
Missing stringData Sets how this alarm is to handle missing data points. The following values are supported:
missing,ignore,breachingandnotBreaching. Defaults tomissing.- Unit string
The unit for the alarm's associated metric.
- Comparison
Operator string The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported:
GreaterThanOrEqualToThreshold,GreaterThanThreshold,LessThanThreshold,LessThanOrEqualToThreshold. Additionally, the valuesLessThanLowerOrGreaterThanUpperThreshold,LessThanLowerThreshold, andGreaterThanUpperThresholdare used only for alarms based on anomaly detection models.- Evaluation
Periods int The number of periods over which data is compared to the specified threshold.
- Actions
Enabled bool Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to
true.- Alarm
Actions []interface{} The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- Alarm
Description string The description for the alarm.
- Datapoints
To intAlarm The number of datapoints that must be breaching to trigger the alarm.
- Dimensions map[string]string
The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here.
- Evaluate
Low stringSample Count Percentiles Used only for alarms based on percentiles. If you specify
ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specifyevaluateor omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported:ignore, andevaluate.- Extended
Statistic string The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
- Insufficient
Data []interface{}Actions The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- Metric
Name string The name for the alarm's associated metric. See docs for supported metrics.
- Metric
Queries []MetricAlarm Metric Query Args Enables you to create an alarm based on a metric math expression. You may specify at most 20.
- Name string
The descriptive name for the alarm. This name must be unique within the user's AWS account
- Namespace string
The namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.
- Ok
Actions []interface{} The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- Period int
The period in seconds over which the specified
statisticis applied. Valid values are10,30, or any multiple of60.- Statistic string
The statistic to apply to the alarm's associated metric. Either of the following is supported:
SampleCount,Average,Sum,Minimum,Maximum- map[string]string
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.NOTE: If you specify at least one
metric_query, you may not specify ametric_name,namespace,periodorstatistic. If you do not specify ametric_query, you must specify each of these (although you may useextended_statisticinstead ofstatistic).- Threshold float64
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
- Threshold
Metric stringId If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
- Treat
Missing stringData Sets how this alarm is to handle missing data points. The following values are supported:
missing,ignore,breachingandnotBreaching. Defaults tomissing.- Unit string
The unit for the alarm's associated metric.
- comparison
Operator String The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported:
GreaterThanOrEqualToThreshold,GreaterThanThreshold,LessThanThreshold,LessThanOrEqualToThreshold. Additionally, the valuesLessThanLowerOrGreaterThanUpperThreshold,LessThanLowerThreshold, andGreaterThanUpperThresholdare used only for alarms based on anomaly detection models.- evaluation
Periods Integer The number of periods over which data is compared to the specified threshold.
- actions
Enabled Boolean Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to
true.- alarm
Actions List<String> The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- alarm
Description String The description for the alarm.
- datapoints
To IntegerAlarm The number of datapoints that must be breaching to trigger the alarm.
- dimensions Map<String,String>
The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here.
- evaluate
Low StringSample Count Percentiles Used only for alarms based on percentiles. If you specify
ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specifyevaluateor omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported:ignore, andevaluate.- extended
Statistic String The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
- insufficient
Data List<String>Actions The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- metric
Name String The name for the alarm's associated metric. See docs for supported metrics.
- metric
Queries List<MetricAlarm Metric Query> Enables you to create an alarm based on a metric math expression. You may specify at most 20.
- name String
The descriptive name for the alarm. This name must be unique within the user's AWS account
- namespace String
The namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.
- ok
Actions List<String> The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- period Integer
The period in seconds over which the specified
statisticis applied. Valid values are10,30, or any multiple of60.- statistic String
The statistic to apply to the alarm's associated metric. Either of the following is supported:
SampleCount,Average,Sum,Minimum,Maximum- Map<String,String>
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.NOTE: If you specify at least one
metric_query, you may not specify ametric_name,namespace,periodorstatistic. If you do not specify ametric_query, you must specify each of these (although you may useextended_statisticinstead ofstatistic).- threshold Double
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
- threshold
Metric StringId If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
- treat
Missing StringData Sets how this alarm is to handle missing data points. The following values are supported:
missing,ignore,breachingandnotBreaching. Defaults tomissing.- unit String
The unit for the alarm's associated metric.
- comparison
Operator string The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported:
GreaterThanOrEqualToThreshold,GreaterThanThreshold,LessThanThreshold,LessThanOrEqualToThreshold. Additionally, the valuesLessThanLowerOrGreaterThanUpperThreshold,LessThanLowerThreshold, andGreaterThanUpperThresholdare used only for alarms based on anomaly detection models.- evaluation
Periods number The number of periods over which data is compared to the specified threshold.
- actions
Enabled boolean Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to
true.- alarm
Actions (string | Topic)[] The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- alarm
Description string The description for the alarm.
- datapoints
To numberAlarm The number of datapoints that must be breaching to trigger the alarm.
- dimensions {[key: string]: string}
The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here.
- evaluate
Low stringSample Count Percentiles Used only for alarms based on percentiles. If you specify
ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specifyevaluateor omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported:ignore, andevaluate.- extended
Statistic string The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
- insufficient
Data (string | Topic)[]Actions The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- metric
Name string The name for the alarm's associated metric. See docs for supported metrics.
- metric
Queries MetricAlarm Metric Query[] Enables you to create an alarm based on a metric math expression. You may specify at most 20.
- name string
The descriptive name for the alarm. This name must be unique within the user's AWS account
- namespace string
The namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.
- ok
Actions (string | Topic)[] The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- period number
The period in seconds over which the specified
statisticis applied. Valid values are10,30, or any multiple of60.- statistic string
The statistic to apply to the alarm's associated metric. Either of the following is supported:
SampleCount,Average,Sum,Minimum,Maximum- {[key: string]: string}
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.NOTE: If you specify at least one
metric_query, you may not specify ametric_name,namespace,periodorstatistic. If you do not specify ametric_query, you must specify each of these (although you may useextended_statisticinstead ofstatistic).- threshold number
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
- threshold
Metric stringId If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
- treat
Missing stringData Sets how this alarm is to handle missing data points. The following values are supported:
missing,ignore,breachingandnotBreaching. Defaults tomissing.- unit string
The unit for the alarm's associated metric.
- comparison_
operator str The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported:
GreaterThanOrEqualToThreshold,GreaterThanThreshold,LessThanThreshold,LessThanOrEqualToThreshold. Additionally, the valuesLessThanLowerOrGreaterThanUpperThreshold,LessThanLowerThreshold, andGreaterThanUpperThresholdare used only for alarms based on anomaly detection models.- evaluation_
periods int The number of periods over which data is compared to the specified threshold.
- actions_
enabled bool Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to
true.- alarm_
actions Sequence[str] The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- alarm_
description str The description for the alarm.
- datapoints_
to_ intalarm The number of datapoints that must be breaching to trigger the alarm.
- dimensions Mapping[str, str]
The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here.
- evaluate_
low_ strsample_ count_ percentiles Used only for alarms based on percentiles. If you specify
ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specifyevaluateor omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported:ignore, andevaluate.- extended_
statistic str The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
- insufficient_
data_ Sequence[str]actions The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- metric_
name str The name for the alarm's associated metric. See docs for supported metrics.
- metric_
queries Sequence[MetricAlarm Metric Query Args] Enables you to create an alarm based on a metric math expression. You may specify at most 20.
- name str
The descriptive name for the alarm. This name must be unique within the user's AWS account
- namespace str
The namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.
- ok_
actions Sequence[str] The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- period int
The period in seconds over which the specified
statisticis applied. Valid values are10,30, or any multiple of60.- statistic str
The statistic to apply to the alarm's associated metric. Either of the following is supported:
SampleCount,Average,Sum,Minimum,Maximum- Mapping[str, str]
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.NOTE: If you specify at least one
metric_query, you may not specify ametric_name,namespace,periodorstatistic. If you do not specify ametric_query, you must specify each of these (although you may useextended_statisticinstead ofstatistic).- threshold float
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
- threshold_
metric_ strid If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
- treat_
missing_ strdata Sets how this alarm is to handle missing data points. The following values are supported:
missing,ignore,breachingandnotBreaching. Defaults tomissing.- unit str
The unit for the alarm's associated metric.
- comparison
Operator String The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported:
GreaterThanOrEqualToThreshold,GreaterThanThreshold,LessThanThreshold,LessThanOrEqualToThreshold. Additionally, the valuesLessThanLowerOrGreaterThanUpperThreshold,LessThanLowerThreshold, andGreaterThanUpperThresholdare used only for alarms based on anomaly detection models.- evaluation
Periods Number The number of periods over which data is compared to the specified threshold.
- actions
Enabled Boolean Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to
true.- alarm
Actions List<String | > The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- alarm
Description String The description for the alarm.
- datapoints
To NumberAlarm The number of datapoints that must be breaching to trigger the alarm.
- dimensions Map<String>
The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here.
- evaluate
Low StringSample Count Percentiles Used only for alarms based on percentiles. If you specify
ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specifyevaluateor omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported:ignore, andevaluate.- extended
Statistic String The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
- insufficient
Data List<String | >Actions The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- metric
Name String The name for the alarm's associated metric. See docs for supported metrics.
- metric
Queries List<Property Map> Enables you to create an alarm based on a metric math expression. You may specify at most 20.
- name String
The descriptive name for the alarm. This name must be unique within the user's AWS account
- namespace String
The namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.
- ok
Actions List<String | > The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- period Number
The period in seconds over which the specified
statisticis applied. Valid values are10,30, or any multiple of60.- statistic String
The statistic to apply to the alarm's associated metric. Either of the following is supported:
SampleCount,Average,Sum,Minimum,Maximum- Map<String>
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.NOTE: If you specify at least one
metric_query, you may not specify ametric_name,namespace,periodorstatistic. If you do not specify ametric_query, you must specify each of these (although you may useextended_statisticinstead ofstatistic).- threshold Number
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
- threshold
Metric StringId If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
- treat
Missing StringData Sets how this alarm is to handle missing data points. The following values are supported:
missing,ignore,breachingandnotBreaching. Defaults tomissing.- unit String
The unit for the alarm's associated metric.
Outputs
All input properties are implicitly available as output properties. Additionally, the MetricAlarm resource produces the following output properties:
Look up Existing MetricAlarm Resource
Get an existing MetricAlarm resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: MetricAlarmState, opts?: CustomResourceOptions): MetricAlarm@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
actions_enabled: Optional[bool] = None,
alarm_actions: Optional[Sequence[str]] = None,
alarm_description: Optional[str] = None,
arn: Optional[str] = None,
comparison_operator: Optional[str] = None,
datapoints_to_alarm: Optional[int] = None,
dimensions: Optional[Mapping[str, str]] = None,
evaluate_low_sample_count_percentiles: Optional[str] = None,
evaluation_periods: Optional[int] = None,
extended_statistic: Optional[str] = None,
insufficient_data_actions: Optional[Sequence[str]] = None,
metric_name: Optional[str] = None,
metric_queries: Optional[Sequence[MetricAlarmMetricQueryArgs]] = None,
name: Optional[str] = None,
namespace: Optional[str] = None,
ok_actions: Optional[Sequence[str]] = None,
period: Optional[int] = None,
statistic: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
threshold: Optional[float] = None,
threshold_metric_id: Optional[str] = None,
treat_missing_data: Optional[str] = None,
unit: Optional[str] = None) -> MetricAlarmfunc GetMetricAlarm(ctx *Context, name string, id IDInput, state *MetricAlarmState, opts ...ResourceOption) (*MetricAlarm, error)public static MetricAlarm Get(string name, Input<string> id, MetricAlarmState? state, CustomResourceOptions? opts = null)public static MetricAlarm get(String name, Output<String> id, MetricAlarmState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Actions
Enabled bool Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to
true.- Alarm
Actions List<string> The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- Alarm
Description string The description for the alarm.
- Arn string
The ARN of the CloudWatch Metric Alarm.
- Comparison
Operator string The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported:
GreaterThanOrEqualToThreshold,GreaterThanThreshold,LessThanThreshold,LessThanOrEqualToThreshold. Additionally, the valuesLessThanLowerOrGreaterThanUpperThreshold,LessThanLowerThreshold, andGreaterThanUpperThresholdare used only for alarms based on anomaly detection models.- Datapoints
To intAlarm The number of datapoints that must be breaching to trigger the alarm.
- Dimensions Dictionary<string, string>
The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here.
- Evaluate
Low stringSample Count Percentiles Used only for alarms based on percentiles. If you specify
ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specifyevaluateor omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported:ignore, andevaluate.- Evaluation
Periods int The number of periods over which data is compared to the specified threshold.
- Extended
Statistic string The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
- Insufficient
Data List<string>Actions The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- Metric
Name string The name for the alarm's associated metric. See docs for supported metrics.
- Metric
Queries List<MetricAlarm Metric Query> Enables you to create an alarm based on a metric math expression. You may specify at most 20.
- Name string
The descriptive name for the alarm. This name must be unique within the user's AWS account
- Namespace string
The namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.
- Ok
Actions List<string> The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- Period int
The period in seconds over which the specified
statisticis applied. Valid values are10,30, or any multiple of60.- Statistic string
The statistic to apply to the alarm's associated metric. Either of the following is supported:
SampleCount,Average,Sum,Minimum,Maximum- Dictionary<string, string>
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.NOTE: If you specify at least one
metric_query, you may not specify ametric_name,namespace,periodorstatistic. If you do not specify ametric_query, you must specify each of these (although you may useextended_statisticinstead ofstatistic).- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- Threshold double
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
- Threshold
Metric stringId If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
- Treat
Missing stringData Sets how this alarm is to handle missing data points. The following values are supported:
missing,ignore,breachingandnotBreaching. Defaults tomissing.- Unit string
The unit for the alarm's associated metric.
- Actions
Enabled bool Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to
true.- Alarm
Actions []interface{} The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- Alarm
Description string The description for the alarm.
- Arn string
The ARN of the CloudWatch Metric Alarm.
- Comparison
Operator string The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported:
GreaterThanOrEqualToThreshold,GreaterThanThreshold,LessThanThreshold,LessThanOrEqualToThreshold. Additionally, the valuesLessThanLowerOrGreaterThanUpperThreshold,LessThanLowerThreshold, andGreaterThanUpperThresholdare used only for alarms based on anomaly detection models.- Datapoints
To intAlarm The number of datapoints that must be breaching to trigger the alarm.
- Dimensions map[string]string
The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here.
- Evaluate
Low stringSample Count Percentiles Used only for alarms based on percentiles. If you specify
ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specifyevaluateor omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported:ignore, andevaluate.- Evaluation
Periods int The number of periods over which data is compared to the specified threshold.
- Extended
Statistic string The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
- Insufficient
Data []interface{}Actions The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- Metric
Name string The name for the alarm's associated metric. See docs for supported metrics.
- Metric
Queries []MetricAlarm Metric Query Args Enables you to create an alarm based on a metric math expression. You may specify at most 20.
- Name string
The descriptive name for the alarm. This name must be unique within the user's AWS account
- Namespace string
The namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.
- Ok
Actions []interface{} The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- Period int
The period in seconds over which the specified
statisticis applied. Valid values are10,30, or any multiple of60.- Statistic string
The statistic to apply to the alarm's associated metric. Either of the following is supported:
SampleCount,Average,Sum,Minimum,Maximum- map[string]string
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.NOTE: If you specify at least one
metric_query, you may not specify ametric_name,namespace,periodorstatistic. If you do not specify ametric_query, you must specify each of these (although you may useextended_statisticinstead ofstatistic).- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- Threshold float64
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
- Threshold
Metric stringId If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
- Treat
Missing stringData Sets how this alarm is to handle missing data points. The following values are supported:
missing,ignore,breachingandnotBreaching. Defaults tomissing.- Unit string
The unit for the alarm's associated metric.
- actions
Enabled Boolean Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to
true.- alarm
Actions List<String> The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- alarm
Description String The description for the alarm.
- arn String
The ARN of the CloudWatch Metric Alarm.
- comparison
Operator String The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported:
GreaterThanOrEqualToThreshold,GreaterThanThreshold,LessThanThreshold,LessThanOrEqualToThreshold. Additionally, the valuesLessThanLowerOrGreaterThanUpperThreshold,LessThanLowerThreshold, andGreaterThanUpperThresholdare used only for alarms based on anomaly detection models.- datapoints
To IntegerAlarm The number of datapoints that must be breaching to trigger the alarm.
- dimensions Map<String,String>
The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here.
- evaluate
Low StringSample Count Percentiles Used only for alarms based on percentiles. If you specify
ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specifyevaluateor omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported:ignore, andevaluate.- evaluation
Periods Integer The number of periods over which data is compared to the specified threshold.
- extended
Statistic String The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
- insufficient
Data List<String>Actions The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- metric
Name String The name for the alarm's associated metric. See docs for supported metrics.
- metric
Queries List<MetricAlarm Metric Query> Enables you to create an alarm based on a metric math expression. You may specify at most 20.
- name String
The descriptive name for the alarm. This name must be unique within the user's AWS account
- namespace String
The namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.
- ok
Actions List<String> The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- period Integer
The period in seconds over which the specified
statisticis applied. Valid values are10,30, or any multiple of60.- statistic String
The statistic to apply to the alarm's associated metric. Either of the following is supported:
SampleCount,Average,Sum,Minimum,Maximum- Map<String,String>
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.NOTE: If you specify at least one
metric_query, you may not specify ametric_name,namespace,periodorstatistic. If you do not specify ametric_query, you must specify each of these (although you may useextended_statisticinstead ofstatistic).- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- threshold Double
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
- threshold
Metric StringId If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
- treat
Missing StringData Sets how this alarm is to handle missing data points. The following values are supported:
missing,ignore,breachingandnotBreaching. Defaults tomissing.- unit String
The unit for the alarm's associated metric.
- actions
Enabled boolean Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to
true.- alarm
Actions (string | Topic)[] The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- alarm
Description string The description for the alarm.
- arn string
The ARN of the CloudWatch Metric Alarm.
- comparison
Operator string The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported:
GreaterThanOrEqualToThreshold,GreaterThanThreshold,LessThanThreshold,LessThanOrEqualToThreshold. Additionally, the valuesLessThanLowerOrGreaterThanUpperThreshold,LessThanLowerThreshold, andGreaterThanUpperThresholdare used only for alarms based on anomaly detection models.- datapoints
To numberAlarm The number of datapoints that must be breaching to trigger the alarm.
- dimensions {[key: string]: string}
The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here.
- evaluate
Low stringSample Count Percentiles Used only for alarms based on percentiles. If you specify
ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specifyevaluateor omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported:ignore, andevaluate.- evaluation
Periods number The number of periods over which data is compared to the specified threshold.
- extended
Statistic string The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
- insufficient
Data (string | Topic)[]Actions The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- metric
Name string The name for the alarm's associated metric. See docs for supported metrics.
- metric
Queries MetricAlarm Metric Query[] Enables you to create an alarm based on a metric math expression. You may specify at most 20.
- name string
The descriptive name for the alarm. This name must be unique within the user's AWS account
- namespace string
The namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.
- ok
Actions (string | Topic)[] The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- period number
The period in seconds over which the specified
statisticis applied. Valid values are10,30, or any multiple of60.- statistic string
The statistic to apply to the alarm's associated metric. Either of the following is supported:
SampleCount,Average,Sum,Minimum,Maximum- {[key: string]: string}
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.NOTE: If you specify at least one
metric_query, you may not specify ametric_name,namespace,periodorstatistic. If you do not specify ametric_query, you must specify each of these (although you may useextended_statisticinstead ofstatistic).- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- threshold number
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
- threshold
Metric stringId If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
- treat
Missing stringData Sets how this alarm is to handle missing data points. The following values are supported:
missing,ignore,breachingandnotBreaching. Defaults tomissing.- unit string
The unit for the alarm's associated metric.
- actions_
enabled bool Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to
true.- alarm_
actions Sequence[str] The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- alarm_
description str The description for the alarm.
- arn str
The ARN of the CloudWatch Metric Alarm.
- comparison_
operator str The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported:
GreaterThanOrEqualToThreshold,GreaterThanThreshold,LessThanThreshold,LessThanOrEqualToThreshold. Additionally, the valuesLessThanLowerOrGreaterThanUpperThreshold,LessThanLowerThreshold, andGreaterThanUpperThresholdare used only for alarms based on anomaly detection models.- datapoints_
to_ intalarm The number of datapoints that must be breaching to trigger the alarm.
- dimensions Mapping[str, str]
The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here.
- evaluate_
low_ strsample_ count_ percentiles Used only for alarms based on percentiles. If you specify
ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specifyevaluateor omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported:ignore, andevaluate.- evaluation_
periods int The number of periods over which data is compared to the specified threshold.
- extended_
statistic str The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
- insufficient_
data_ Sequence[str]actions The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- metric_
name str The name for the alarm's associated metric. See docs for supported metrics.
- metric_
queries Sequence[MetricAlarm Metric Query Args] Enables you to create an alarm based on a metric math expression. You may specify at most 20.
- name str
The descriptive name for the alarm. This name must be unique within the user's AWS account
- namespace str
The namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.
- ok_
actions Sequence[str] The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- period int
The period in seconds over which the specified
statisticis applied. Valid values are10,30, or any multiple of60.- statistic str
The statistic to apply to the alarm's associated metric. Either of the following is supported:
SampleCount,Average,Sum,Minimum,Maximum- Mapping[str, str]
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.NOTE: If you specify at least one
metric_query, you may not specify ametric_name,namespace,periodorstatistic. If you do not specify ametric_query, you must specify each of these (although you may useextended_statisticinstead ofstatistic).- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- threshold float
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
- threshold_
metric_ strid If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
- treat_
missing_ strdata Sets how this alarm is to handle missing data points. The following values are supported:
missing,ignore,breachingandnotBreaching. Defaults tomissing.- unit str
The unit for the alarm's associated metric.
- actions
Enabled Boolean Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to
true.- alarm
Actions List<String | > The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- alarm
Description String The description for the alarm.
- arn String
The ARN of the CloudWatch Metric Alarm.
- comparison
Operator String The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported:
GreaterThanOrEqualToThreshold,GreaterThanThreshold,LessThanThreshold,LessThanOrEqualToThreshold. Additionally, the valuesLessThanLowerOrGreaterThanUpperThreshold,LessThanLowerThreshold, andGreaterThanUpperThresholdare used only for alarms based on anomaly detection models.- datapoints
To NumberAlarm The number of datapoints that must be breaching to trigger the alarm.
- dimensions Map<String>
The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation here.
- evaluate
Low StringSample Count Percentiles Used only for alarms based on percentiles. If you specify
ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specifyevaluateor omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported:ignore, andevaluate.- evaluation
Periods Number The number of periods over which data is compared to the specified threshold.
- extended
Statistic String The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
- insufficient
Data List<String | >Actions The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- metric
Name String The name for the alarm's associated metric. See docs for supported metrics.
- metric
Queries List<Property Map> Enables you to create an alarm based on a metric math expression. You may specify at most 20.
- name String
The descriptive name for the alarm. This name must be unique within the user's AWS account
- namespace String
The namespace for the alarm's associated metric. See docs for the list of namespaces. See docs for supported metrics.
- ok
Actions List<String | > The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
- period Number
The period in seconds over which the specified
statisticis applied. Valid values are10,30, or any multiple of60.- statistic String
The statistic to apply to the alarm's associated metric. Either of the following is supported:
SampleCount,Average,Sum,Minimum,Maximum- Map<String>
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.NOTE: If you specify at least one
metric_query, you may not specify ametric_name,namespace,periodorstatistic. If you do not specify ametric_query, you must specify each of these (although you may useextended_statisticinstead ofstatistic).- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- threshold Number
The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
- threshold
Metric StringId If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.
- treat
Missing StringData Sets how this alarm is to handle missing data points. The following values are supported:
missing,ignore,breachingandnotBreaching. Defaults tomissing.- unit String
The unit for the alarm's associated metric.
Supporting Types
MetricAlarmMetricQuery, MetricAlarmMetricQueryArgs
- Id string
A short name used to tie this object to the results in the response. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
- Account
Id string The ID of the account where the metrics are located, if this is a cross-account alarm.
- Expression string
The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the id of the other metrics to refer to those metrics, and can also use the id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
- Label string
A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents.
- Metric
Metric
Alarm Metric Query Metric The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
- Period int
Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of
60. For high-resolution metrics, valid values are1,5,10,30, or any multiple of60.- Return
Data bool Specify exactly one
metric_queryto betrueto use thatmetric_queryresult as the alarm.NOTE: You must specify either
metricorexpression. Not both.
- Id string
A short name used to tie this object to the results in the response. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
- Account
Id string The ID of the account where the metrics are located, if this is a cross-account alarm.
- Expression string
The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the id of the other metrics to refer to those metrics, and can also use the id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
- Label string
A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents.
- Metric
Metric
Alarm Metric Query Metric The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
- Period int
Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of
60. For high-resolution metrics, valid values are1,5,10,30, or any multiple of60.- Return
Data bool Specify exactly one
metric_queryto betrueto use thatmetric_queryresult as the alarm.NOTE: You must specify either
metricorexpression. Not both.
- id String
A short name used to tie this object to the results in the response. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
- account
Id String The ID of the account where the metrics are located, if this is a cross-account alarm.
- expression String
The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the id of the other metrics to refer to those metrics, and can also use the id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
- label String
A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents.
- metric
Metric
Alarm Metric Query Metric The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
- period Integer
Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of
60. For high-resolution metrics, valid values are1,5,10,30, or any multiple of60.- return
Data Boolean Specify exactly one
metric_queryto betrueto use thatmetric_queryresult as the alarm.NOTE: You must specify either
metricorexpression. Not both.
- id string
A short name used to tie this object to the results in the response. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
- account
Id string The ID of the account where the metrics are located, if this is a cross-account alarm.
- expression string
The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the id of the other metrics to refer to those metrics, and can also use the id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
- label string
A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents.
- metric
Metric
Alarm Metric Query Metric The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
- period number
Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of
60. For high-resolution metrics, valid values are1,5,10,30, or any multiple of60.- return
Data boolean Specify exactly one
metric_queryto betrueto use thatmetric_queryresult as the alarm.NOTE: You must specify either
metricorexpression. Not both.
- id str
A short name used to tie this object to the results in the response. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
- account_
id str The ID of the account where the metrics are located, if this is a cross-account alarm.
- expression str
The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the id of the other metrics to refer to those metrics, and can also use the id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
- label str
A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents.
- metric
Metric
Alarm Metric Query Metric The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
- period int
Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of
60. For high-resolution metrics, valid values are1,5,10,30, or any multiple of60.- return_
data bool Specify exactly one
metric_queryto betrueto use thatmetric_queryresult as the alarm.NOTE: You must specify either
metricorexpression. Not both.
- id String
A short name used to tie this object to the results in the response. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
- account
Id String The ID of the account where the metrics are located, if this is a cross-account alarm.
- expression String
The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the id of the other metrics to refer to those metrics, and can also use the id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
- label String
A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents.
- metric Property Map
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
- period Number
Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of
60. For high-resolution metrics, valid values are1,5,10,30, or any multiple of60.- return
Data Boolean Specify exactly one
metric_queryto betrueto use thatmetric_queryresult as the alarm.NOTE: You must specify either
metricorexpression. Not both.
MetricAlarmMetricQueryMetric, MetricAlarmMetricQueryMetricArgs
- Metric
Name string The name for this metric. See docs for supported metrics.
- Period int
Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of
60. For high-resolution metrics, valid values are1,5,10,30, or any multiple of60.- Stat string
The statistic to apply to this metric. See docs for supported statistics.
- Dimensions Dictionary<string, string>
The dimensions for this metric. For the list of available dimensions see the AWS documentation here.
- Namespace string
The namespace for this metric. See docs for the list of namespaces. See docs for supported metrics.
- Unit string
The unit for this metric.
- Metric
Name string The name for this metric. See docs for supported metrics.
- Period int
Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of
60. For high-resolution metrics, valid values are1,5,10,30, or any multiple of60.- Stat string
The statistic to apply to this metric. See docs for supported statistics.
- Dimensions map[string]string
The dimensions for this metric. For the list of available dimensions see the AWS documentation here.
- Namespace string
The namespace for this metric. See docs for the list of namespaces. See docs for supported metrics.
- Unit string
The unit for this metric.
- metric
Name String The name for this metric. See docs for supported metrics.
- period Integer
Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of
60. For high-resolution metrics, valid values are1,5,10,30, or any multiple of60.- stat String
The statistic to apply to this metric. See docs for supported statistics.
- dimensions Map<String,String>
The dimensions for this metric. For the list of available dimensions see the AWS documentation here.
- namespace String
The namespace for this metric. See docs for the list of namespaces. See docs for supported metrics.
- unit String
The unit for this metric.
- metric
Name string The name for this metric. See docs for supported metrics.
- period number
Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of
60. For high-resolution metrics, valid values are1,5,10,30, or any multiple of60.- stat string
The statistic to apply to this metric. See docs for supported statistics.
- dimensions {[key: string]: string}
The dimensions for this metric. For the list of available dimensions see the AWS documentation here.
- namespace string
The namespace for this metric. See docs for the list of namespaces. See docs for supported metrics.
- unit string
The unit for this metric.
- metric_
name str The name for this metric. See docs for supported metrics.
- period int
Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of
60. For high-resolution metrics, valid values are1,5,10,30, or any multiple of60.- stat str
The statistic to apply to this metric. See docs for supported statistics.
- dimensions Mapping[str, str]
The dimensions for this metric. For the list of available dimensions see the AWS documentation here.
- namespace str
The namespace for this metric. See docs for the list of namespaces. See docs for supported metrics.
- unit str
The unit for this metric.
- metric
Name String The name for this metric. See docs for supported metrics.
- period Number
Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of
60. For high-resolution metrics, valid values are1,5,10,30, or any multiple of60.- stat String
The statistic to apply to this metric. See docs for supported statistics.
- dimensions Map<String>
The dimensions for this metric. For the list of available dimensions see the AWS documentation here.
- namespace String
The namespace for this metric. See docs for the list of namespaces. See docs for supported metrics.
- unit String
The unit for this metric.
Import
Using pulumi import, import CloudWatch Metric Alarm using the alarm_name. For example:
$ pulumi import aws:cloudwatch/metricAlarm:MetricAlarm test alarm-12345
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
awsTerraform Provider.
Try AWS Native preview for resources not in the classic version.