Package software.amazon.awscdk.services.cloudwatch

Class AnomalyDetectionAlarmProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudwatch.AnomalyDetectionAlarmProps.Jsii$Proxy

All Implemented Interfaces:

AnomalyDetectionAlarmProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

AnomalyDetectionAlarmProps

@Stability(Stable)
@Internal
public static final class AnomalyDetectionAlarmProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements AnomalyDetectionAlarmProps

An implementation for AnomalyDetectionAlarmProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudwatch.AnomalyDetectionAlarmProps

AnomalyDetectionAlarmProps.Builder, AnomalyDetectionAlarmProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(AnomalyDetectionAlarmProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the AnomalyDetectionAlarmProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Boolean	getActionsEnabled()	Whether the actions for this alarm are enabled.
final String	getAlarmDescription()	Description for the alarm.
final String	getAlarmName()	Name of the alarm.
final ComparisonOperator	getComparisonOperator()	Comparison operator to use to check if metric is breaching.
final Number	getDatapointsToAlarm()	The number of datapoints that must be breaching to trigger the alarm.
final String	getEvaluateLowSampleCountPercentile()	Specifies whether to evaluate the data and potentially change the alarm state if there are too few data points to be statistically significant.
final Number	getEvaluationPeriods()	The number of periods over which data is compared to the specified threshold.
final IMetric	getMetric()	The metric to add the alarm on.
final Duration	getPeriod()	(deprecated) The period over which the specified statistic is applied.
final String	getStatistic()	(deprecated) What function to use for aggregating.
final Number	getStdDevs()	The number of standard deviations to use for the anomaly detection band.
final TreatMissingData	getTreatMissingData()	Sets how this alarm is to handle missing data points.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(AnomalyDetectionAlarmProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the AnomalyDetectionAlarmProps.Builder.

Method Details

getEvaluationPeriods

public final Number getEvaluationPeriods()

Description copied from interface: AnomalyDetectionAlarmProps

The number of periods over which data is compared to the specified threshold.

Specified by:

getEvaluationPeriods in interface AnomalyDetectionAlarmProps

getMetric

public final IMetric getMetric()

Description copied from interface: AnomalyDetectionAlarmProps

The metric to add the alarm on.

Metric objects can be obtained from most resources, or you can construct custom Metric objects by instantiating one.

Specified by:

getMetric in interface AnomalyDetectionAlarmProps

getActionsEnabled

public final Boolean getActionsEnabled()

Description copied from interface: AnomalyDetectionAlarmProps

Whether the actions for this alarm are enabled.

Default: true

Specified by:

getActionsEnabled in interface AnomalyDetectionAlarmProps

getAlarmDescription

public final String getAlarmDescription()

Description copied from interface: AnomalyDetectionAlarmProps

Description for the alarm.

Default: No description

Specified by:

getAlarmDescription in interface AnomalyDetectionAlarmProps

getAlarmName

public final String getAlarmName()

Description copied from interface: AnomalyDetectionAlarmProps

Name of the alarm.

Default: Automatically generated name

Specified by:

getAlarmName in interface AnomalyDetectionAlarmProps

getComparisonOperator

public final ComparisonOperator getComparisonOperator()

Description copied from interface: AnomalyDetectionAlarmProps

Comparison operator to use to check if metric is breaching.

Must be one of the anomaly detection operators:

• LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD
• GREATER_THAN_UPPER_THRESHOLD
• LESS_THAN_LOWER_THRESHOLD

Default: LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD

Specified by:

getComparisonOperator in interface AnomalyDetectionAlarmProps

getDatapointsToAlarm

public final Number getDatapointsToAlarm()

Description copied from interface: AnomalyDetectionAlarmProps

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. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.

Default: ``evaluationPeriods``

Specified by:

getDatapointsToAlarm in interface AnomalyDetectionAlarmProps

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation

getEvaluateLowSampleCountPercentile

public final String getEvaluateLowSampleCountPercentile()

Description copied from interface: AnomalyDetectionAlarmProps

Specifies whether to evaluate the data and potentially change the alarm state if there are too few data points to be statistically significant.

Used only for alarms that are based on percentiles.

Default: - Not configured.

Specified by:

getEvaluateLowSampleCountPercentile in interface AnomalyDetectionAlarmProps

getPeriod

public final Duration getPeriod()

Description copied from interface: AnomalyDetectionAlarmProps

(deprecated) The period over which the specified statistic is applied.

Cannot be used with MathExpression objects.

Default: - The period from the metric

Specified by:

getPeriod in interface AnomalyDetectionAlarmProps

getStatistic

public final String getStatistic()

Description copied from interface: AnomalyDetectionAlarmProps

(deprecated) What function to use for aggregating.

Can be one of the following:

• "Minimum" | "min"
• "Maximum" | "max"
• "Average" | "avg"
• "Sum" | "sum"
• "SampleCount | "n"
• "pNN.NN"

Cannot be used with MathExpression objects.

Default: - The statistic from the metric

Specified by:

getStatistic in interface AnomalyDetectionAlarmProps

getStdDevs

public final Number getStdDevs()

Description copied from interface: AnomalyDetectionAlarmProps

The number of standard deviations to use for the anomaly detection band.

The higher the value, the wider the band.

• Must be greater than 0. A value of 0 or negative values would not make sense in the context of calculating standard deviations.
• There is no strict maximum value defined, as standard deviations can theoretically extend infinitely. However, in practice, values beyond 5 or 6 standard deviations are rarely used, as they would result in an extremely wide anomaly detection band, potentially missing significant anomalies.

Default: 2

Specified by:

getStdDevs in interface AnomalyDetectionAlarmProps

getTreatMissingData

public final TreatMissingData getTreatMissingData()

Description copied from interface: AnomalyDetectionAlarmProps

Sets how this alarm is to handle missing data points.

Default: TreatMissingData.Missing

Specified by:

getTreatMissingData in interface AnomalyDetectionAlarmProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object