interface GuAlarmProps {
    actionsEnabled?: boolean;
    alarmDescription?: string;
    alarmName?: string;
    app: string;
    comparisonOperator?: ComparisonOperator;
    datapointsToAlarm?: number;
    evaluateLowSampleCountPercentile?: string;
    evaluationPeriods: number;
    metric: IMetric;
    okAction?: boolean;
    snsTopicName: string;
    threshold: number;
    treatMissingData?: TreatMissingData;

Hierarchy (view full)


actionsEnabled?: boolean

Whether the actions for this alarm are enabled


alarmDescription?: string

Description for the alarm


No description
alarmName?: string

Name of the alarm


Automatically generated name
app: string
comparisonOperator?: ComparisonOperator

Comparison to use to check if metric is breaching


datapointsToAlarm?: number

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.

evaluateLowSampleCountPercentile?: string

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.


- Not configured.
evaluationPeriods: number

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

metric: IMetric

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.

okAction?: boolean
snsTopicName: string
threshold: number

The value against which the specified statistic is compared.

treatMissingData?: TreatMissingData

Sets how this alarm is to handle missing data points.