ApiAlarmOpts
Defined in: packages/core/src/config/types.ts:773
Shared, all-optional, all-defaulted alarm knobs.
Extends
Section titled “Extends”Properties
Section titled “Properties”comparisonOperator?
Section titled “comparisonOperator?”
optionalcomparisonOperator?:ComparisonOperator
Defined in: packages/core/src/config/types.ts:750
Inherited from
Section titled “Inherited from”BaseAlarmOpts.comparisonOperator
datapointsToAlarm?
Section titled “datapointsToAlarm?”
optionaldatapointsToAlarm?:number
Defined in: packages/core/src/config/types.ts:747
Datapoints within evaluationPeriods that must breach. Default = evaluationPeriods.
Inherited from
Section titled “Inherited from”BaseAlarmOpts.datapointsToAlarm
evaluationPeriods?
Section titled “evaluationPeriods?”
optionalevaluationPeriods?:number
Defined in: packages/core/src/config/types.ts:745
Consecutive periods evaluated. Default 1.
Inherited from
Section titled “Inherited from”BaseAlarmOpts.evaluationPeriods
overrides?
Section titled “overrides?”
optionaloverrides?:Record<string,Partial<BaseAlarmOpts>>
Defined in: packages/core/src/config/types.ts:775
periodMinutes?
Section titled “periodMinutes?”
optionalperiodMinutes?:number
Defined in: packages/core/src/config/types.ts:743
Metric period in minutes. Default 5. Floor 1 (sub-minute high-res not allowed).
Inherited from
Section titled “Inherited from”statistic?
Section titled “statistic?”
optionalstatistic?:string
Defined in: packages/core/src/config/types.ts:749
CloudWatch statistic, e.g. “Sum” | “Average” | “p99”. Category default applies.
Inherited from
Section titled “Inherited from”target?
Section titled “target?”
optionaltarget?:string[] |"all"
Defined in: packages/core/src/config/types.ts:774
threshold?
Section titled “threshold?”
optionalthreshold?:number
Defined in: packages/core/src/config/types.ts:741
Numeric threshold. Category default applies when omitted.
Inherited from
Section titled “Inherited from”treatMissingData?
Section titled “treatMissingData?”
optionaltreatMissingData?:TreatMissingData
Defined in: packages/core/src/config/types.ts:751
Inherited from
Section titled “Inherited from”© 2026 Axis Tech. Powered by axis-tech.co.