Interface ICreateAlarmOptions

Properties needed to make an alarm from a metric.

Namespace: Amazon.CDK.AWS.CloudWatch

Assembly: Amazon.CDK.AWS.CloudWatch.dll

Syntax (csharp)

public interface ICreateAlarmOptions

Syntax (vb)

Public Interface ICreateAlarmOptions

Remarks

stability: Stable

Synopsis

Properties

ActionsEnabled	Whether the actions for this alarm are enabled.
AlarmDescription	Description for the alarm.
AlarmName	Name of the alarm.
ComparisonOperator	Comparison to use to check if metric is breaching.
DatapointsToAlarm	The number of datapoints that must be breaching to trigger the alarm.
EvaluateLowSampleCountPercentile	Specifies whether to evaluate the data and potentially change the alarm state if there are too few data points to be statistically significant.
EvaluationPeriods	The number of periods over which data is compared to the specified threshold.
Period	The period over which the specified statistic is applied.
Statistic	What function to use for aggregating.
Threshold	The value against which the specified statistic is compared.
TreatMissingData	Sets how this alarm is to handle missing data points.

Properties

ActionsEnabled

Whether the actions for this alarm are enabled.

virtual Nullable<bool> ActionsEnabled { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

default: true stability: Stable

AlarmDescription

Description for the alarm.

virtual string AlarmDescription { get; }

Property Value

System.String

Remarks

default: No description stability: Stable

AlarmName

Name of the alarm.

virtual string AlarmName { get; }

Property Value

System.String

Remarks

default: Automatically generated name stability: Stable

ComparisonOperator

Comparison to use to check if metric is breaching.

virtual Nullable<ComparisonOperator> ComparisonOperator { get; }

Property Value

System.Nullable<ComparisonOperator>

Remarks

default: GreaterThanOrEqualToThreshold stability: Stable

DatapointsToAlarm

The number of datapoints that must be breaching to trigger the alarm.

virtual Nullable<double> DatapointsToAlarm { get; }

Property Value

System.Nullable<System.Double>

Remarks

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 stability: Stable see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation

EvaluateLowSampleCountPercentile

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

virtual string EvaluateLowSampleCountPercentile { get; }

Property Value

System.String

Remarks

Used only for alarms that are based on percentiles. default:

• Not configured. stability: Stable

EvaluationPeriods

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

double EvaluationPeriods { get; }

Property Value

System.Double

Remarks

stability: Stable

Period

The period over which the specified statistic is applied.

virtual Duration Period { get; }

Property Value

Duration

Remarks

default: Duration.minutes(5) stability: Stable

Statistic

What function to use for aggregating.

virtual string Statistic { get; }

Property Value

System.String

Remarks

Can be one of the following:

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

Threshold

The value against which the specified statistic is compared.

double Threshold { get; }

Property Value

System.Double

Remarks

stability: Stable

TreatMissingData

Sets how this alarm is to handle missing data points.

virtual Nullable<TreatMissingData> TreatMissingData { get; }

Property Value

System.Nullable<TreatMissingData>

Remarks

default: TreatMissingData.Missing stability: Stable