software.amazon.awscdk.services.cloudwatch

Interface CreateAlarmOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AlarmProps

All Known Implementing Classes:

AlarmProps.Jsii$Proxy, CreateAlarmOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/0.13.2 (build a2116e9)",
           date="2019-07-01T16:58:11.751Z")
 @Stability(value=Experimental)
public interface CreateAlarmOptions
extends software.amazon.jsii.JsiiSerializable

Properties needed to make an alarm from a metric. EXPERIMENTAL

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CreateAlarmOptions.Builder A builder for CreateAlarmOptions
static class	CreateAlarmOptions.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
static CreateAlarmOptions.Builder	builder()
Boolean	getActionsEnabled() Whether the actions for this alarm are enabled.
String	getAlarmDescription() Description for the alarm.
String	getAlarmName() Name of the alarm.
ComparisonOperator	getComparisonOperator() Comparison to use to check if metric is breaching.
Number	getDatapointsToAlarm() The number of datapoints that must be breaching to trigger the alarm.
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.
Number	getEvaluationPeriods() The number of periods over which data is compared to the specified threshold.
software.amazon.awscdk.core.Duration	getPeriod() The period over which the specified statistic is applied.
String	getStatistic() What function to use for aggregating.
Number	getThreshold() The value against which the specified statistic is compared.
TreatMissingData	getTreatMissingData() Sets how this alarm is to handle missing data points.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEvaluationPeriods

@Stability(value=Experimental)
Number getEvaluationPeriods()

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

getThreshold

@Stability(value=Experimental)
Number getThreshold()

The value against which the specified statistic is compared. EXPERIMENTAL

getActionsEnabled

@Stability(value=Experimental)
Boolean getActionsEnabled()

Whether the actions for this alarm are enabled. Default: true EXPERIMENTAL

getAlarmDescription

@Stability(value=Experimental)
String getAlarmDescription()

Description for the alarm. Default: No description EXPERIMENTAL

getAlarmName

@Stability(value=Experimental)
String getAlarmName()

Name of the alarm. Default: Automatically generated name EXPERIMENTAL

getComparisonOperator

@Stability(value=Experimental)
ComparisonOperator getComparisonOperator()

Comparison to use to check if metric is breaching. Default: GreaterThanOrEqualToThreshold EXPERIMENTAL

getDatapointsToAlarm

@Stability(value=Experimental)
Number 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. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide. Default: ``evaluationPeriods`` EXPERIMENTAL

See Also:

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

getEvaluateLowSampleCountPercentile

@Stability(value=Experimental)
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. Used only for alarms that are based on percentiles. Default: - Not configured. EXPERIMENTAL

getPeriod

@Stability(value=Experimental)
software.amazon.awscdk.core.Duration getPeriod()

The period over which the specified statistic is applied. Default: Duration.minutes(5) EXPERIMENTAL

getStatistic

@Stability(value=Experimental)
String getStatistic()

What function to use for aggregating. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" Default: Average EXPERIMENTAL

getTreatMissingData

@Stability(value=Experimental)
TreatMissingData getTreatMissingData()

Sets how this alarm is to handle missing data points. Default: TreatMissingData.Missing EXPERIMENTAL

builder

@Stability(value=Experimental)
static CreateAlarmOptions.Builder builder()

Returns:

a CreateAlarmOptions.Builder of CreateAlarmOptions