Interface GuAlarmProps

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 Summary)

Properties

actionsEnabled? alarmDescription? alarmName? app comparisonOperator? datapointsToAlarm? evaluateLowSampleCountPercentile? evaluationPeriods metric okAction? snsTopicName threshold treatMissingData?

Properties

Optional ReadonlyactionsEnabled

actionsEnabled?: boolean

Whether the actions for this alarm are enabled

Default

true

Optional ReadonlyalarmDescription

alarmDescription?: string

Description for the alarm

Default

No description

Optional ReadonlyalarmName

alarmName?: string

Name of the alarm

Default

Automatically generated name

app

app: string

Optional ReadonlycomparisonOperator

comparisonOperator?: ComparisonOperator

Comparison to use to check if metric is breaching

Default

GreaterThanOrEqualToThreshold

Optional ReadonlydatapointsToAlarm

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.

Default

evaluationPeriods

See

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

Optional ReadonlyevaluateLowSampleCountPercentile

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.

Default

- Not configured.

ReadonlyevaluationPeriods

evaluationPeriods: number

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

Readonlymetric

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.

OptionalokAction

okAction?: boolean

snsTopicName

snsTopicName: string

Readonlythreshold

threshold: number

The value against which the specified statistic is compared.

Optional ReadonlytreatMissingData

treatMissingData?: TreatMissingData

Sets how this alarm is to handle missing data points.

Default

TreatMissingData.Missing

Settings

Member Visibility

On This Page

Properties