diff --git a/API.md b/API.md index b0e7bc47..007397df 100644 --- a/API.md +++ b/API.md @@ -3973,6 +3973,9 @@ const anomalyDetectionThreshold: AnomalyDetectionThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -4192,6 +4195,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -7403,6 +7445,9 @@ const availabilityThreshold: AvailabilityThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -7619,6 +7664,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -8798,6 +8882,9 @@ const changeInSecretCountThreshold: ChangeInSecretCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -9017,6 +9104,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -9959,6 +10085,9 @@ const consumedCapacityThreshold: ConsumedCapacityThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -10175,6 +10304,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -10255,6 +10423,9 @@ const customAlarmThreshold: CustomAlarmThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -10470,6 +10641,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -11772,6 +11982,9 @@ const customThreshold: CustomThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -11991,6 +12204,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -12237,6 +12489,9 @@ const daysSinceUpdateThreshold: DaysSinceUpdateThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -12453,6 +12708,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -12531,6 +12825,9 @@ const daysToExpiryThreshold: DaysToExpiryThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -12747,6 +13044,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -13250,6 +13586,9 @@ const durationThreshold: DurationThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -13466,6 +13805,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -16101,6 +16479,9 @@ const errorCountThreshold: ErrorCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -16317,6 +16698,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -16395,6 +16815,9 @@ const errorRateThreshold: ErrorRateThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -16611,6 +17034,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -17553,6 +18015,9 @@ const firehoseStreamLimitThreshold: FirehoseStreamLimitThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -17769,6 +18234,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -17849,6 +18353,9 @@ const fullRestartCountThreshold: FullRestartCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -18065,6 +18572,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -18561,6 +19107,9 @@ const healthyTaskCountThreshold: HealthyTaskCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -18777,6 +19326,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -18855,6 +19443,9 @@ const healthyTaskPercentThreshold: HealthyTaskPercentThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -19071,6 +19662,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -19149,6 +19779,9 @@ const highConnectionCountThreshold: HighConnectionCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -19365,6 +19998,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -19443,6 +20115,9 @@ const highMessagesPublishedThreshold: HighMessagesPublishedThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -19659,6 +20334,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -19737,6 +20451,9 @@ const highTpsThreshold: HighTpsThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -19953,6 +20670,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -21949,6 +22705,9 @@ const latencyThreshold: LatencyThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -22165,6 +22924,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -22243,6 +23041,9 @@ const logLevelCountThreshold: LogLevelCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -22459,6 +23260,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -22726,6 +23566,9 @@ const lowConnectionCountThreshold: LowConnectionCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -22942,6 +23785,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -23020,6 +23902,9 @@ const lowMessagesPublishedThreshold: LowMessagesPublishedThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -23236,6 +24121,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -23314,6 +24238,9 @@ const lowTpsThreshold: LowTpsThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -23530,6 +24457,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -23608,6 +24574,9 @@ const maxAgeThreshold: MaxAgeThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -23824,6 +24793,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -23902,6 +24910,9 @@ const maxDowntimeThreshold: MaxDowntimeThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -24118,6 +25129,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -24196,6 +25246,9 @@ const maxIncomingMessagesCountThreshold: MaxIncomingMessagesCountThreshold = { . | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -24412,6 +25465,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -24490,6 +25582,9 @@ const maxItemsCountThreshold: MaxItemsCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -24706,6 +25801,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -24784,6 +25918,9 @@ const maxIteratorAgeThreshold: MaxIteratorAgeThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -25000,6 +26137,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -25078,6 +26254,9 @@ const maxMessageAgeThreshold: MaxMessageAgeThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -25294,6 +26473,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -25372,6 +26590,9 @@ const maxMessageCountThreshold: MaxMessageCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -25588,6 +26809,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -25666,6 +26926,9 @@ const maxSecretCountThreshold: MaxSecretCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -25882,6 +27145,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -25960,6 +27262,9 @@ const maxTimeToDrainThreshold: MaxTimeToDrainThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -26176,6 +27481,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -26254,6 +27598,9 @@ const maxUsedSwapMemoryThreshold: MaxUsedSwapMemoryThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -26470,6 +27817,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -26660,6 +28046,9 @@ const minFreeableMemoryThreshold: MinFreeableMemoryThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -26876,6 +28265,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -26954,6 +28382,9 @@ const minIncomingMessagesCountThreshold: MinIncomingMessagesCountThreshold = { . | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -27170,6 +28601,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -27248,6 +28718,9 @@ const minMessageCountThreshold: MinMessageCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -27464,6 +28937,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -27542,6 +29054,9 @@ const minProcessedBytesThreshold: MinProcessedBytesThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -27758,6 +29273,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -27838,6 +29392,9 @@ const minRunningTaskCountThreshold: MinRunningTaskCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -28054,6 +29611,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -28132,6 +29728,9 @@ const minSecretCountThreshold: MinSecretCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -28348,6 +29947,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -28426,6 +30064,9 @@ const minUsageCountThreshold: MinUsageCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -28642,6 +30283,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -29833,6 +31513,9 @@ const notificationsFailedThreshold: NotificationsFailedThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -30049,6 +31732,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -30127,6 +31849,9 @@ const openSearchClusterAutomatedSnapshotFailureThreshold: OpenSearchClusterAutom | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -30343,6 +32068,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -30421,6 +32185,9 @@ const openSearchClusterIndexWritesBlockedThreshold: OpenSearchClusterIndexWrites | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -30637,6 +32404,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -31420,6 +33226,9 @@ const openSearchClusterNodesThreshold: OpenSearchClusterNodesThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -31636,6 +33445,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -31714,6 +33562,9 @@ const openSearchClusterStatusCustomization: OpenSearchClusterStatusCustomization | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -31930,6 +33781,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -32008,6 +33898,9 @@ const openSearchKmsKeyErrorThreshold: OpenSearchKmsKeyErrorThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -32224,6 +34117,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -32302,6 +34234,9 @@ const openSearchKmsKeyInaccessibleThreshold: OpenSearchKmsKeyInaccessibleThresho | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -32518,6 +34453,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -33333,6 +35307,9 @@ const recordsFailedThreshold: RecordsFailedThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -33549,6 +35526,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -33627,6 +35643,9 @@ const recordsThrottledThreshold: RecordsThrottledThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -33843,6 +35862,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -34314,6 +36372,9 @@ const runningTaskCountThreshold: RunningTaskCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -34530,6 +36591,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -34608,6 +36708,9 @@ const runningTaskRateThreshold: RunningTaskRateThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -34824,6 +36927,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -39148,6 +41290,9 @@ const throttledEventsThreshold: ThrottledEventsThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -39364,6 +41509,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -39442,6 +41626,9 @@ const unhealthyTaskCountThreshold: UnhealthyTaskCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -39658,6 +41845,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -39736,6 +41962,9 @@ const usageCountThreshold: UsageCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -39952,6 +42181,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript @@ -40030,6 +42298,9 @@ const usageThreshold: UsageThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | +| overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | +| overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | @@ -40246,6 +42517,45 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `overrideAnnotationColor`Optional + +```typescript +public readonly overrideAnnotationColor: string; +``` + +- *Type:* string +- *Default:* no override (default color) + +If specified, it modifies the final alarm annotation color. + +--- + +##### `overrideAnnotationLabel`Optional + +```typescript +public readonly overrideAnnotationLabel: string; +``` + +- *Type:* string +- *Default:* no override (default label) + +If specified, it modifies the final alarm annotation label. + +--- + +##### `overrideAnnotationVisibility`Optional + +```typescript +public readonly overrideAnnotationVisibility: boolean; +``` + +- *Type:* boolean +- *Default:* no override (default visibility) + +If specified, it modifies the final alarm annotation visibility. + +--- + ##### `period`Optional ```typescript diff --git a/lib/common/alarm/CustomAlarmThreshold.ts b/lib/common/alarm/CustomAlarmThreshold.ts index d772706a..c4896425 100644 --- a/lib/common/alarm/CustomAlarmThreshold.ts +++ b/lib/common/alarm/CustomAlarmThreshold.ts @@ -138,6 +138,27 @@ export interface CustomAlarmThreshold { */ readonly fillAlarmRange?: boolean; + /** + * If specified, it modifies the final alarm annotation color. + * + * @default - no override (default color) + */ + readonly overrideAnnotationColor?: string; + + /** + * If specified, it modifies the final alarm annotation label. + * + * @default - no override (default label) + */ + readonly overrideAnnotationLabel?: string; + + /** + * If specified, it modifies the final alarm annotation visibility. + * + * @default - no override (default visibility) + */ + readonly overrideAnnotationVisibility?: boolean; + /** * If specified, adjusts the metric before creating an alarm from it. * diff --git a/test/monitoring/aws-lambda/LambdaFunctionMonitoring.test.ts b/test/monitoring/aws-lambda/LambdaFunctionMonitoring.test.ts index 8a71377e..c969e477 100644 --- a/test/monitoring/aws-lambda/LambdaFunctionMonitoring.test.ts +++ b/test/monitoring/aws-lambda/LambdaFunctionMonitoring.test.ts @@ -1,6 +1,6 @@ import { Duration, Stack } from "aws-cdk-lib"; import { Template } from "aws-cdk-lib/assertions"; -import { ComparisonOperator } from "aws-cdk-lib/aws-cloudwatch"; +import { Color, ComparisonOperator } from "aws-cdk-lib/aws-cloudwatch"; import { Function, InlineCode, @@ -212,12 +212,15 @@ test("snapshot test: all alarms, alarmPrefix on error dedupeString", () => { Warning: { maxErrorRate: 1, datapointsToAlarm: 10, + overrideAnnotationVisibility: false, }, }, addFaultCountAlarm: { Warning: { maxErrorCount: 2, datapointsToAlarm: 20, + overrideAnnotationColor: Color.BROWN, + overrideAnnotationLabel: "Custom annotation label", }, }, addLatencyP50Alarm: { diff --git a/test/monitoring/aws-lambda/__snapshots__/LambdaFunctionMonitoring.test.ts.snap b/test/monitoring/aws-lambda/__snapshots__/LambdaFunctionMonitoring.test.ts.snap index 58b93937..42a059ac 100644 --- a/test/monitoring/aws-lambda/__snapshots__/LambdaFunctionMonitoring.test.ts.snap +++ b/test/monitoring/aws-lambda/__snapshots__/LambdaFunctionMonitoring.test.ts.snap @@ -1318,7 +1318,7 @@ Object { Object { "Ref": "Function76856677", }, - "\\",{\\"label\\":\\"Faults (avg)\\"}]],\\"annotations\\":{\\"horizontal\\":[{\\"label\\":\\"Faults (avg) > 1 for 10 datapoints within 50 minutes\\",\\"value\\":1,\\"yAxis\\":\\"left\\"}]},\\"yAxis\\":{\\"left\\":{\\"min\\":0,\\"label\\":\\"Rate\\",\\"showUnits\\":false}}}},{\\"type\\":\\"metric\\",\\"width\\":6,\\"height\\":5,\\"x\\":18,\\"y\\":1,\\"properties\\":{\\"view\\":\\"timeSeries\\",\\"title\\":\\"Rates\\",\\"region\\":\\"", + "\\",{\\"label\\":\\"Faults (avg)\\"}]],\\"annotations\\":{\\"horizontal\\":[{\\"label\\":\\"Faults (avg) > 1 for 10 datapoints within 50 minutes\\",\\"value\\":1,\\"visible\\":false,\\"yAxis\\":\\"left\\"}]},\\"yAxis\\":{\\"left\\":{\\"min\\":0,\\"label\\":\\"Rate\\",\\"showUnits\\":false}}}},{\\"type\\":\\"metric\\",\\"width\\":6,\\"height\\":5,\\"x\\":18,\\"y\\":1,\\"properties\\":{\\"view\\":\\"timeSeries\\",\\"title\\":\\"Rates\\",\\"region\\":\\"", Object { "Ref": "AWS::Region", }, @@ -1366,7 +1366,7 @@ Object { Object { "Ref": "Function76856677", }, - "\\",{\\"label\\":\\"Faults\\",\\"stat\\":\\"Sum\\"}]],\\"annotations\\":{\\"horizontal\\":[{\\"label\\":\\"Faults > 2 for 20 datapoints within 100 minutes\\",\\"value\\":2,\\"yAxis\\":\\"left\\"}]},\\"yAxis\\":{\\"left\\":{\\"min\\":0,\\"label\\":\\"Count\\",\\"showUnits\\":false}}}},{\\"type\\":\\"metric\\",\\"width\\":8,\\"height\\":5,\\"x\\":0,\\"y\\":11,\\"properties\\":{\\"view\\":\\"timeSeries\\",\\"title\\":\\"CPU Total Time\\",\\"region\\":\\"", + "\\",{\\"label\\":\\"Faults\\",\\"stat\\":\\"Sum\\"}]],\\"annotations\\":{\\"horizontal\\":[{\\"label\\":\\"Custom annotation label\\",\\"value\\":2,\\"color\\":\\"#8c564b\\",\\"yAxis\\":\\"left\\"}]},\\"yAxis\\":{\\"left\\":{\\"min\\":0,\\"label\\":\\"Count\\",\\"showUnits\\":false}}}},{\\"type\\":\\"metric\\",\\"width\\":8,\\"height\\":5,\\"x\\":0,\\"y\\":11,\\"properties\\":{\\"view\\":\\"timeSeries\\",\\"title\\":\\"CPU Total Time\\",\\"region\\":\\"", Object { "Ref": "AWS::Region", }, @@ -2153,7 +2153,7 @@ Object { Object { "Ref": "Function76856677", }, - "\\",{\\"label\\":\\"Faults (avg)\\"}]],\\"annotations\\":{\\"horizontal\\":[{\\"label\\":\\"Faults (avg) > 1 for 10 datapoints within 50 minutes\\",\\"value\\":1,\\"yAxis\\":\\"left\\"}]},\\"yAxis\\":{\\"left\\":{\\"min\\":0,\\"label\\":\\"Rate\\",\\"showUnits\\":false}}}}]}", + "\\",{\\"label\\":\\"Faults (avg)\\"}]],\\"annotations\\":{\\"horizontal\\":[{\\"label\\":\\"Faults (avg) > 1 for 10 datapoints within 50 minutes\\",\\"value\\":1,\\"visible\\":false,\\"yAxis\\":\\"left\\"}]},\\"yAxis\\":{\\"left\\":{\\"min\\":0,\\"label\\":\\"Rate\\",\\"showUnits\\":false}}}}]}", ], ], },