public static final class CfnAlarmProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnAlarmProps
CfnAlarmProps
CfnAlarmProps.Builder, CfnAlarmProps.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
Modifier and Type | Method and Description |
---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(java.lang.Object o) |
java.lang.Object |
getActionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state.
|
java.util.List<java.lang.String> |
getAlarmActions()
The list of actions to execute when this alarm transitions into an ALARM state from any other state.
|
java.lang.String |
getAlarmDescription()
The description of the alarm.
|
java.lang.String |
getAlarmName()
The name of the alarm.
|
java.lang.String |
getComparisonOperator()
The arithmetic operation to use when comparing the specified statistic and threshold.
|
java.lang.Number |
getDatapointsToAlarm()
The number of datapoints that must be breaching to trigger the alarm.
|
java.lang.Object |
getDimensions()
The dimensions for the metric associated with the alarm.
|
java.lang.String |
getEvaluateLowSampleCountPercentile()
Used only for alarms based on percentiles.
|
java.lang.Number |
getEvaluationPeriods()
The number of periods over which data is compared to the specified threshold.
|
java.lang.String |
getExtendedStatistic()
The percentile statistic for the metric associated with the alarm.
|
java.util.List<java.lang.String> |
getInsufficientDataActions()
The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state.
|
java.lang.String |
getMetricName()
The name of the metric associated with the alarm.
|
java.lang.Object |
getMetrics()
An array that enables you to create an alarm based on the result of a metric math expression.
|
java.lang.String |
getNamespace()
The namespace of the metric associated with the alarm.
|
java.util.List<java.lang.String> |
getOkActions()
The actions to execute when this alarm transitions to the `OK` state from any other state.
|
java.lang.Number |
getPeriod()
The period, in seconds, over which the statistic is applied.
|
java.lang.String |
getStatistic()
The statistic for the metric associated with the alarm, other than percentile.
|
java.lang.Number |
getThreshold()
The value to compare with the specified statistic.
|
java.lang.String |
getThresholdMetricId()
In an alarm based on an anomaly detection model, this is the ID of the `ANOMALY_DETECTION_BAND` function used as the threshold for the alarm.
|
java.lang.String |
getTreatMissingData()
Sets how this alarm is to handle missing data points.
|
java.lang.String |
getUnit()
The unit of the metric associated with the alarm.
|
int |
hashCode() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final java.lang.String getComparisonOperator()
CfnAlarmProps
The specified statistic value is used as the first operand.
You can specify the following values: GreaterThanThreshold
, GreaterThanOrEqualToThreshold
, LessThanThreshold
, or LessThanOrEqualToThreshold
.
getComparisonOperator
in interface CfnAlarmProps
public final java.lang.Number getEvaluationPeriods()
CfnAlarmProps
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 .
getEvaluationPeriods
in interface CfnAlarmProps
public final java.lang.Object getActionsEnabled()
CfnAlarmProps
The default is TRUE.
getActionsEnabled
in interface CfnAlarmProps
public final java.util.List<java.lang.String> getAlarmActions()
CfnAlarmProps
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 .
getAlarmActions
in interface CfnAlarmProps
public final java.lang.String getAlarmDescription()
CfnAlarmProps
getAlarmDescription
in interface CfnAlarmProps
public final java.lang.String getAlarmName()
CfnAlarmProps
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.
getAlarmName
in interface CfnAlarmProps
public final java.lang.Number getDatapointsToAlarm()
CfnAlarmProps
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.
getDatapointsToAlarm
in interface CfnAlarmProps
public final java.lang.Object getDimensions()
CfnAlarmProps
For an alarm based on a math expression, you can't specify Dimensions
. Instead, you use Metrics
.
getDimensions
in interface CfnAlarmProps
public final java.lang.String getEvaluateLowSampleCountPercentile()
CfnAlarmProps
If ignore
, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate
or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
getEvaluateLowSampleCountPercentile
in interface CfnAlarmProps
public final java.lang.String getExtendedStatistic()
CfnAlarmProps
For an alarm based on a metric, you must specify either Statistic
or ExtendedStatistic
but not both.
For an alarm based on a math expression, you can't specify ExtendedStatistic
. Instead, you use Metrics
.
getExtendedStatistic
in interface CfnAlarmProps
public final java.util.List<java.lang.String> getInsufficientDataActions()
CfnAlarmProps
Each action is specified as an Amazon Resource Name (ARN).
getInsufficientDataActions
in interface CfnAlarmProps
public final java.lang.String getMetricName()
CfnAlarmProps
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 specify MetricName
.
getMetricName
in interface CfnAlarmProps
public final java.lang.Object getMetrics()
CfnAlarmProps
Each item in the array either retrieves a metric or performs a math expression.
If you specify the Metrics
parameter, you cannot specify MetricName
, Dimensions
, Period
, Namespace
, Statistic
, ExtendedStatistic
, or Unit
.
getMetrics
in interface CfnAlarmProps
public final java.lang.String getNamespace()
CfnAlarmProps
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 use Metrics
instead.
For a list of namespaces for metrics from AWS services, see AWS Services That Publish CloudWatch Metrics.
getNamespace
in interface CfnAlarmProps
public final java.util.List<java.lang.String> getOkActions()
CfnAlarmProps
Each action is specified as an Amazon Resource Name (ARN).
getOkActions
in interface CfnAlarmProps
public final java.lang.Number getPeriod()
CfnAlarmProps
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 the Metrics
parameter.
Minimum: 10
getPeriod
in interface CfnAlarmProps
public final java.lang.String getStatistic()
CfnAlarmProps
For an alarm based on a metric, you must specify either Statistic
or ExtendedStatistic
but not both.
For an alarm based on a math expression, you can't specify Statistic
. Instead, you use Metrics
.
getStatistic
in interface CfnAlarmProps
public final java.lang.Number getThreshold()
CfnAlarmProps
getThreshold
in interface CfnAlarmProps
public final java.lang.String getThresholdMetricId()
CfnAlarmProps
getThresholdMetricId
in interface CfnAlarmProps
public final java.lang.String getTreatMissingData()
CfnAlarmProps
Valid values are breaching
, notBreaching
, ignore
, and missing
. 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.
getTreatMissingData
in interface CfnAlarmProps
public final java.lang.String getUnit()
CfnAlarmProps
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.
getUnit
in interface CfnAlarmProps
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()