cdk-monitoring-constructs/lib/common/alarm/IAlarmAnnotationStrategy.d.ts

[](https://badge.fury.io/js/cdk-monitoring-constructs) [](https://m

import { Alarm, ComparisonOperator, HorizontalAnnotation, Shading } from "aws-cdk-lib/aws-cloudwatch";
import { AlarmMetadata } from "./AlarmFactory";
import { MetricWithAlarmSupport } from "../metric";
export interface AlarmAnnotationStrategyProps extends AlarmMetadata {
    readonly alarm: Alarm;
    readonly metric: MetricWithAlarmSupport;
    readonly comparisonOperator: ComparisonOperator;
    readonly minMetricSamplesToAlarm?: number;
    readonly minSampleCountToEvaluateDatapoint?: number;
    readonly threshold: number;
    readonly datapointsToAlarm: number;
    readonly evaluationPeriods: number;
    readonly fillAlarmRange: boolean;
    readonly overrideAnnotationColor?: string;
    readonly overrideAnnotationLabel?: string;
    readonly overrideAnnotationVisibility?: boolean;
}
/**
 * Helper class for creating annotations for alarms.
 */
export interface IAlarmAnnotationStrategy {
    /**
     * Creates annotation based on the metric and alarm properties.
     * @param props properties necessary to create annotation
     */
    createAnnotation(props: AlarmAnnotationStrategyProps): HorizontalAnnotation;
}
/**
 * Annotation strategy that fills the annotation provided, using the input and user requirements.
 */
export declare abstract class FillingAlarmAnnotationStrategy implements IAlarmAnnotationStrategy {
    createAnnotation(props: AlarmAnnotationStrategyProps): HorizontalAnnotation;
    protected abstract createAnnotationToFill(props: AlarmAnnotationStrategyProps): HorizontalAnnotation;
    protected getAlarmingRangeShade(props: AlarmAnnotationStrategyProps): Shading | undefined;
}
/**
 * Default annotation strategy that returns the built-in alarm annotation.
 */
export declare class DefaultAlarmAnnotationStrategy extends FillingAlarmAnnotationStrategy {
    protected createAnnotationToFill(props: AlarmAnnotationStrategyProps): HorizontalAnnotation;
}