@renovosolutions/cdk-library-cloudwatch-alarms
Version:
AWS CDK Construct Library to automatically create CloudWatch Alarms for resources in a CDK app based on resource type.
33 lines (32 loc) • 983 B
TypeScript
import { aws_cloudwatch as cloudwatch, Duration } from 'aws-cdk-lib';
/**
* The base properties for an alarm where default values
* are consistent across all alarms.
*/
export interface AlarmBaseProps {
/**
* The action to take when an alarm is triggered.
*
* @default - None
*/
readonly alarmAction?: cloudwatch.IAlarmAction;
/**
* The action to take when an alarm enters the ok state.
*
* @default - None
*/
readonly okAction?: cloudwatch.IAlarmAction;
/**
* The action to take when an alarm has insufficient data.
*
* @default - None
*/
readonly insufficientDataAction?: cloudwatch.IAlarmAction;
/**
* How to handle missing data for this alarm.
*
* @default TreatMissingData.MISSING
*/
readonly treatMissingData?: cloudwatch.TreatMissingData;
}
export declare function validateTotalAlarmPeriod(period: Duration, evaluationPeriods: number, alarmName: string): void;