Interface CfnAlarmProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAlarmProps.Jsii$Proxy
CfnAlarm
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.cloudwatch.*; CfnAlarmProps cfnAlarmProps = CfnAlarmProps.builder() .comparisonOperator("comparisonOperator") .evaluationPeriods(123) // the properties below are optional .actionsEnabled(false) .alarmActions(List.of("alarmActions")) .alarmDescription("alarmDescription") .alarmName("alarmName") .datapointsToAlarm(123) .dimensions(List.of(DimensionProperty.builder() .name("name") .value("value") .build())) .evaluateLowSampleCountPercentile("evaluateLowSampleCountPercentile") .extendedStatistic("extendedStatistic") .insufficientDataActions(List.of("insufficientDataActions")) .metricName("metricName") .metrics(List.of(MetricDataQueryProperty.builder() .id("id") // the properties below are optional .accountId("accountId") .expression("expression") .label("label") .metricStat(MetricStatProperty.builder() .metric(MetricProperty.builder() .dimensions(List.of(DimensionProperty.builder() .name("name") .value("value") .build())) .metricName("metricName") .namespace("namespace") .build()) .period(123) .stat("stat") // the properties below are optional .unit("unit") .build()) .period(123) .returnData(false) .build())) .namespace("namespace") .okActions(List.of("okActions")) .period(123) .statistic("statistic") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .threshold(123) .thresholdMetricId("thresholdMetricId") .treatMissingData("treatMissingData") .unit("unit") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnAlarmProps
static final class
An implementation forCfnAlarmProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnAlarmProps.Builder
builder()
default Object
Indicates whether actions should be executed during any changes to the alarm state.The list of actions to execute when this alarm transitions into an ALARM state from any other state.default String
The description of the alarm.default String
The name of the alarm.The arithmetic operation to use when comparing the specified statistic and threshold.default Number
The number of datapoints that must be breaching to trigger the alarm.default Object
The dimensions for the metric associated with the alarm.default String
Used only for alarms based on percentiles.The number of periods over which data is compared to the specified threshold.default String
The percentile statistic for the metric associated with the alarm.The actions to execute when this alarm transitions to theINSUFFICIENT_DATA
state from any other state.default String
The name of the metric associated with the alarm.default Object
An array that enables you to create an alarm based on the result of a metric math expression.default String
The namespace of the metric associated with the alarm.The actions to execute when this alarm transitions to theOK
state from any other state.default Number
The period, in seconds, over which the statistic is applied.default String
The statistic for the metric associated with the alarm, other than percentile.getTags()
A list of key-value pairs to associate with the alarm.default Number
The value to compare with the specified statistic.default String
In an alarm based on an anomaly detection model, this is the ID of theANOMALY_DETECTION_BAND
function used as the threshold for the alarm.default String
Sets how this alarm is to handle missing data points.default String
getUnit()
The unit of the metric associated with the alarm.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getComparisonOperator
The arithmetic operation to use when comparing the specified statistic and threshold.The specified statistic value is used as the first operand.
- See Also:
-
getEvaluationPeriods
The number of periods over which data is compared to the specified threshold.If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and
DatapointsToAlarm
is the M.For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .
- See Also:
-
getActionsEnabled
Indicates whether actions should be executed during any changes to the alarm state.The default is TRUE.
Default: - true
- See Also:
-
getAlarmActions
The list of actions to execute when this alarm transitions into an ALARM state from any other state.Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutMetricAlarm in the Amazon CloudWatch API Reference .
- See Also:
-
getAlarmDescription
The description of the alarm.- See Also:
-
getAlarmName
The name of the alarm.If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- See Also:
-
getDatapointsToAlarm
The number of datapoints that must be breaching to trigger the alarm.This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for
EvaluationPeriods
is the N value. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .If you omit this parameter, CloudWatch uses the same value here that you set for
EvaluationPeriods
, and the alarm goes to alarm state if that many consecutive periods are breaching.- See Also:
-
getDimensions
The dimensions for the metric associated with the alarm.For an alarm based on a math expression, you can't specify
Dimensions
. Instead, you useMetrics
.- See Also:
-
getEvaluateLowSampleCountPercentile
Used only for alarms based on percentiles.If
ignore
, the alarm state does not change during periods with too few data points to be statistically significant. Ifevaluate
or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.- See Also:
-
getExtendedStatistic
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.For an alarm based on a metric, you must specify either
Statistic
orExtendedStatistic
but not both.For an alarm based on a math expression, you can't specify
ExtendedStatistic
. Instead, you useMetrics
.- See Also:
-
getInsufficientDataActions
The actions to execute when this alarm transitions to theINSUFFICIENT_DATA
state from any other state.Each action is specified as an Amazon Resource Name (ARN).
- See Also:
-
getMetricName
The name of the metric associated with the alarm.This is required for an alarm based on a metric. For an alarm based on a math expression, you use
Metrics
instead and you can't specifyMetricName
.- See Also:
-
getMetrics
An array that enables you to create an alarm based on the result of a metric math expression.Each item in the array either retrieves a metric or performs a math expression.
If you specify the
Metrics
parameter, you cannot specifyMetricName
,Dimensions
,Period
,Namespace
,Statistic
,ExtendedStatistic
, orUnit
.- See Also:
-
getNamespace
The namespace of the metric associated with the alarm.This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify
Namespace
and you useMetrics
instead.For a list of namespaces for metrics from AWS services, see AWS Services That Publish CloudWatch Metrics.
- See Also:
-
getOkActions
The actions to execute when this alarm transitions to theOK
state from any other state.Each action is specified as an Amazon Resource Name (ARN).
- See Also:
-
getPeriod
The period, in seconds, over which the statistic is applied.This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
For an alarm based on a math expression, you can't specify
Period
, and instead you use theMetrics
parameter.Minimum: 10
- See Also:
-
getStatistic
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, useExtendedStatistic
.For an alarm based on a metric, you must specify either
Statistic
orExtendedStatistic
but not both.For an alarm based on a math expression, you can't specify
Statistic
. Instead, you useMetrics
.- See Also:
-
getTags
A list of key-value pairs to associate with the alarm.You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the
cloudwatch:TagResource
permission.Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
- See Also:
-
getThreshold
The value to compare with the specified statistic.- See Also:
-
getThresholdMetricId
In an alarm based on an anomaly detection model, this is the ID of theANOMALY_DETECTION_BAND
function used as the threshold for the alarm.- See Also:
-
getTreatMissingData
Sets how this alarm is to handle missing data points.Valid values are
breaching
,notBreaching
,ignore
, andmissing
. For more information, see Configuring How CloudWatch Alarms Treat Missing Data in the Amazon CloudWatch User Guide .If you omit this parameter, the default behavior of
missing
is used.- See Also:
-
getUnit
The unit of the metric associated with the alarm.Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a
Metrics
array.You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
- See Also:
-
builder
- Returns:
- a
CfnAlarmProps.Builder
ofCfnAlarmProps
-