From ffb35f321ad5c0618747da9b1868864aaf039d22 Mon Sep 17 00:00:00 2001 From: Bilal Amarni Date: Wed, 16 Oct 2024 16:38:34 +0100 Subject: [PATCH] fix: add sampleCountMetricId to CustomAlarmThreshold This provides support for `minSampleCountToEvaluateDatapoint` when using eg. `ErrorAlarmFactory`. See #466 where the feature was introduced. --- API.md | 988 +++++++++++++++++++++++ lib/common/alarm/CustomAlarmThreshold.ts | 14 + 2 files changed, 1002 insertions(+) diff --git a/API.md b/API.md index 51668985..ef0e38ca 100644 --- a/API.md +++ b/API.md @@ -4153,6 +4153,7 @@ const anomalyDetectionThreshold: AnomalyDetectionThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | alarmWhenAboveTheBand | boolean | *No description.* | | alarmWhenBelowTheBand | boolean | *No description.* | @@ -4457,6 +4458,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -8752,6 +8769,7 @@ const availabilityThreshold: AvailabilityThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minAvailabilityPercent | number | *No description.* | @@ -9053,6 +9071,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -10511,6 +10545,7 @@ const changeInSecretCountThreshold: ChangeInSecretCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | alarmWhenDecreased | boolean | *No description.* | | alarmWhenIncreased | boolean | *No description.* | @@ -10815,6 +10850,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -11961,6 +12012,7 @@ const consumedCapacityThreshold: ConsumedCapacityThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxConsumedCapacityUnits | number | *No description.* | @@ -12262,6 +12314,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -12322,6 +12390,7 @@ const customAlarmThreshold: CustomAlarmThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | --- @@ -12622,6 +12691,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -14112,6 +14197,7 @@ const customThreshold: CustomThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | *No description.* | | threshold | number | *No description.* | @@ -14416,6 +14502,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -14642,6 +14744,7 @@ const daysSinceUpdateThreshold: DaysSinceUpdateThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxDaysSinceUpdate | number | *No description.* | @@ -14943,6 +15046,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -15001,6 +15120,7 @@ const daysToExpiryThreshold: DaysToExpiryThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minDaysToExpiry | number | *No description.* | @@ -15302,6 +15422,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -15892,6 +16028,7 @@ const durationThreshold: DurationThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxDuration | aws-cdk-lib.Duration | *No description.* | @@ -16193,6 +16330,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -19349,6 +19502,7 @@ const errorCountThreshold: ErrorCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxErrorCount | number | *No description.* | @@ -19650,6 +19804,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -19708,6 +19878,7 @@ const errorRateThreshold: ErrorRateThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxErrorRate | number | *No description.* | @@ -20009,6 +20180,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -21066,6 +21253,7 @@ const firehoseStreamLimitThreshold: FirehoseStreamLimitThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | safetyThresholdLimit | number | Threshold value between [0.0, 1.0) for when the alarm should be triggered. | @@ -21367,6 +21555,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -21687,6 +21891,7 @@ const fullRestartCountThreshold: FullRestartCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxFullRestartCount | number | *No description.* | @@ -21988,6 +22193,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -22560,6 +22781,7 @@ const healthyTaskCountThreshold: HealthyTaskCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minHealthyTasks | number | *No description.* | @@ -22861,6 +23083,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -22919,6 +23157,7 @@ const healthyTaskPercentThreshold: HealthyTaskPercentThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minHealthyTaskPercent | number | *No description.* | @@ -23220,6 +23459,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -23278,6 +23533,7 @@ const highConnectionCountThreshold: HighConnectionCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxConnectionCount | number | *No description.* | @@ -23579,6 +23835,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -23637,6 +23909,7 @@ const highMessagesPublishedThreshold: HighMessagesPublishedThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxMessagesPublishedCount | number | *No description.* | @@ -23938,6 +24211,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -23996,6 +24285,7 @@ const highServerlessDatabaseCapacityThreshold: HighServerlessDatabaseCapacityThr | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxServerlessDatabaseCapacity | number | *No description.* | @@ -24297,6 +24587,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -24355,6 +24661,7 @@ const highTpsThreshold: HighTpsThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxTps | number | *No description.* | @@ -24656,6 +24963,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -27176,6 +27499,7 @@ const latencyThreshold: LatencyThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxLatency | aws-cdk-lib.Duration | *No description.* | @@ -27477,6 +27801,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -27535,6 +27875,7 @@ const logLevelCountThreshold: LogLevelCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxLogCount | number | Threshold for the number of logs to alarm on. | @@ -27836,6 +28177,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -28126,6 +28483,7 @@ const lowConnectionCountThreshold: LowConnectionCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minConnectionCount | number | *No description.* | @@ -28427,6 +28785,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -28485,6 +28859,7 @@ const lowMessagesPublishedThreshold: LowMessagesPublishedThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minMessagesPublishedCount | number | *No description.* | @@ -28786,6 +29161,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -28844,6 +29235,7 @@ const lowTpsThreshold: LowTpsThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minTps | number | *No description.* | @@ -29145,6 +29537,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -29203,6 +29611,7 @@ const maxAgeThreshold: MaxAgeThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxAgeInMillis | number | *No description.* | @@ -29504,6 +29913,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -29562,6 +29987,7 @@ const maxDowntimeThreshold: MaxDowntimeThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxDowntimeInMillis | number | *No description.* | @@ -29863,6 +30289,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -29921,6 +30363,7 @@ const maxIncomingMessagesCountThreshold: MaxIncomingMessagesCountThreshold = { . | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxIncomingMessagesCount | number | *No description.* | @@ -30222,6 +30665,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -30280,6 +30739,7 @@ const maxItemsCountThreshold: MaxItemsCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxItemsCount | number | *No description.* | @@ -30581,6 +31041,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -30639,6 +31115,7 @@ const maxIteratorAgeThreshold: MaxIteratorAgeThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxAgeInMillis | number | *No description.* | @@ -30940,6 +31417,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -30998,6 +31491,7 @@ const maxMessageAgeThreshold: MaxMessageAgeThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxAgeInSeconds | number | *No description.* | @@ -31299,6 +31793,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -31357,6 +31867,7 @@ const maxMessageCountThreshold: MaxMessageCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxMessageCount | number | *No description.* | @@ -31658,6 +32169,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -31716,6 +32243,7 @@ const maxOffsetLagThreshold: MaxOffsetLagThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxOffsetLag | number | *No description.* | @@ -32017,6 +32545,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -32075,6 +32619,7 @@ const maxSecretCountThreshold: MaxSecretCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxSecretCount | number | *No description.* | @@ -32376,6 +32921,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -32434,6 +32995,7 @@ const maxTimeToDrainThreshold: MaxTimeToDrainThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxTimeToDrain | aws-cdk-lib.Duration | *No description.* | @@ -32735,6 +33297,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -32793,6 +33371,7 @@ const maxUsageCountThreshold: MaxUsageCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxCount | number | *No description.* | @@ -33094,6 +33673,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -33152,6 +33747,7 @@ const maxUsedSwapMemoryThreshold: MaxUsedSwapMemoryThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxUsedSwapMemoryInBytes | number | *No description.* | @@ -33453,6 +34049,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -33623,6 +34235,7 @@ const minFreeableMemoryThreshold: MinFreeableMemoryThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minFreeableMemoryInBytes | number | *No description.* | @@ -33924,6 +34537,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -33982,6 +34611,7 @@ const minIncomingMessagesCountThreshold: MinIncomingMessagesCountThreshold = { . | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minIncomingMessagesCount | number | *No description.* | @@ -34283,6 +34913,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -34341,6 +34987,7 @@ const minMessageCountThreshold: MinMessageCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minMessageCount | number | *No description.* | @@ -34642,6 +35289,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -34700,6 +35363,7 @@ const minProcessedBytesThreshold: MinProcessedBytesThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minProcessedBytes | number | Threshold for the least number of bytes processed. | @@ -35001,6 +35665,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -35061,6 +35741,7 @@ const minRunningTaskCountThreshold: MinRunningTaskCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minRunningTasks | number | *No description.* | @@ -35362,6 +36043,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -35420,6 +36117,7 @@ const minSecretCountThreshold: MinSecretCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minSecretCount | number | *No description.* | @@ -35721,6 +36419,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -35779,6 +36493,7 @@ const minUsageCountThreshold: MinUsageCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minCount | number | *No description.* | @@ -36080,6 +36795,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -37350,6 +38081,7 @@ const notificationsFailedThreshold: NotificationsFailedThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxNotificationsFailedCount | number | *No description.* | @@ -37651,6 +38383,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -37709,6 +38457,7 @@ const openSearchClusterAutomatedSnapshotFailureThreshold: OpenSearchClusterAutom | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxFailures | number | *No description.* | @@ -38010,6 +38759,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -38068,6 +38833,7 @@ const openSearchClusterIndexWritesBlockedThreshold: OpenSearchClusterIndexWrites | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxBlockedWrites | number | *No description.* | @@ -38369,6 +39135,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -39228,6 +40010,7 @@ const openSearchClusterNodesThreshold: OpenSearchClusterNodesThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minNodes | number | *No description.* | @@ -39529,6 +40312,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -39587,6 +40386,7 @@ const openSearchClusterStatusCustomization: OpenSearchClusterStatusCustomization | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | status | OpenSearchClusterStatus \| ElasticsearchClusterStatus | *No description.* | @@ -39888,6 +40688,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -39946,6 +40762,7 @@ const openSearchKmsKeyErrorThreshold: OpenSearchKmsKeyErrorThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxErrors | number | *No description.* | @@ -40247,6 +41064,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -40305,6 +41138,7 @@ const openSearchKmsKeyInaccessibleThreshold: OpenSearchKmsKeyInaccessibleThresho | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxAccessAttempts | number | *No description.* | @@ -40606,6 +41440,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -42032,6 +42882,7 @@ const recordsFailedThreshold: RecordsFailedThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxRecordsFailedThreshold | number | *No description.* | @@ -42333,6 +43184,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -42391,6 +43258,7 @@ const recordsThrottledThreshold: RecordsThrottledThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxRecordsThrottledThreshold | number | *No description.* | @@ -42692,6 +43560,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -43239,6 +44123,7 @@ const runningTaskCountThreshold: RunningTaskCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxRunningTasks | number | *No description.* | @@ -43540,6 +44425,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -43598,6 +44499,7 @@ const runningTaskRateThreshold: RunningTaskRateThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxRunningTaskRate | number | *No description.* | @@ -43899,6 +44801,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -49168,6 +50086,7 @@ const throttledEventsThreshold: ThrottledEventsThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxThrottledEventsThreshold | number | *No description.* | @@ -49469,6 +50388,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -49527,6 +50462,7 @@ const unhealthyTaskCountThreshold: UnhealthyTaskCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxUnhealthyTasks | number | *No description.* | @@ -49828,6 +50764,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript @@ -49886,6 +50838,7 @@ const usageCountThreshold: UsageCountThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxUsageCount | number | *No description.* | @@ -50227,6 +51180,24 @@ An optional link included in the generated ticket description body. --- +##### ~~`sampleCountMetricId`~~Optional + +- *Deprecated:* Use MaxUsageCountThreshold instead. + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### ~~`treatMissingDataOverride`~~Optional - *Deprecated:* Use MaxUsageCountThreshold instead. @@ -50289,6 +51260,7 @@ const usageThreshold: UsageThreshold = { ... } | 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. | +| sampleCountMetricId | string | This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxUsagePercent | number | *No description.* | @@ -50590,6 +51562,22 @@ An optional link included in the generated ticket description body. --- +##### `sampleCountMetricId`Optional + +```typescript +public readonly sampleCountMetricId: string; +``` + +- *Type:* string + +This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
. + +In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics +property that should be used as the sampleCount metric for the new MathExpression as described in the documentation +for minSampleCountToEvaluateDatapoint. + +--- + ##### `treatMissingDataOverride`Optional ```typescript diff --git a/lib/common/alarm/CustomAlarmThreshold.ts b/lib/common/alarm/CustomAlarmThreshold.ts index 623db0cf..a3585581 100644 --- a/lib/common/alarm/CustomAlarmThreshold.ts +++ b/lib/common/alarm/CustomAlarmThreshold.ts @@ -51,6 +51,20 @@ export interface CustomAlarmThreshold { */ readonly minSampleCountToEvaluateDatapoint?: number; + /** + * This property is required in the following situation: + *
    + *
  1. minSampleCountToEvaluateDatapoint is specified
    2. + *
  2. the metric used for the alarm is a MathExpression
    3. + *
  3. the MathExpression is composed of more than one metric
    4. + *
+ * + * In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics + * property that should be used as the sampleCount metric for the new MathExpression as described in the documentation + * for minSampleCountToEvaluateDatapoint. + */ + readonly sampleCountMetricId?: string; + /** * Specifies how many samples (N) of the metric is needed to trigger the alarm. * If this property is specified, a composite alarm is created of the following: