MetricAlarm

import type { MetricAlarm } from "https://aws-api.deno.dev/v0.3/services/cloudwatch.ts?docs=full";

The details about a metric alarm.

interface MetricAlarm {

ActionsEnabled?: boolean | null;

AlarmActions: string[];

AlarmArn?: string | null;

AlarmConfigurationUpdatedTimestamp?: Date | number | null;

AlarmDescription?: string | null;

AlarmName?: string | null;

ComparisonOperator?: ComparisonOperator | null;

DatapointsToAlarm?: number | null;

Dimensions: Dimension[];

EvaluateLowSampleCountPercentile?: string | null;

EvaluationPeriods?: number | null;

ExtendedStatistic?: string | null;

InsufficientDataActions: string[];

MetricName?: string | null;

Metrics: MetricDataQuery[];

Namespace?: string | null;

OKActions: string[];

Period?: number | null;

StateReason?: string | null;

StateReasonData?: string | null;

StateUpdatedTimestamp?: Date | number | null;

StateValue?: StateValue | null;

Statistic?: Statistic | null;

Threshold?: number | null;

ThresholdMetricId?: string | null;

TreatMissingData?: string | null;

Unit?: StandardUnit | null;

}

§Properties

ActionsEnabled?: boolean | null

[src]

Indicates whether actions should be executed during any changes to the alarm state.

AlarmActions: string[]

[src]

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

AlarmArn?: string | null

[src]

The Amazon Resource Name (ARN) of the alarm.

AlarmConfigurationUpdatedTimestamp?: Date | number | null

[src]

The time stamp of the last update to the alarm configuration.

AlarmDescription?: string | null

[src]

The description of the alarm.

AlarmName?: string | null

[src]

The name of the alarm.

ComparisonOperator?: ComparisonOperator | null

[src]

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

DatapointsToAlarm?: number | null

[src]

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

Dimensions: Dimension[]

[src]

The dimensions for the metric associated with the alarm.

EvaluateLowSampleCountPercentile?: string | null

[src]

Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

EvaluationPeriods?: number | null

[src]

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

ExtendedStatistic?: string | null

[src]

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

InsufficientDataActions: string[]

[src]

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

MetricName?: string | null

[src]

The name of the metric associated with the alarm, if this is an alarm based on a single metric.

Metrics: MetricDataQuery[]

[src]

An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnData set to true.

Namespace?: string | null

[src]

The namespace of the metric associated with the alarm.

OKActions: string[]

[src]

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Period?: number | null

[src]

The period, in seconds, over which the statistic is applied.

StateReason?: string | null

[src]

An explanation for the alarm state, in text format.