From 064d54fca62f7f62ed68ef40870db672cc7ee9f5 Mon Sep 17 00:00:00 2001 From: Eugene Cheung <81188333+echeung-amzn@users.noreply.github.com> Date: Wed, 27 Sep 2023 10:28:10 -0400 Subject: [PATCH] chore: update some docs (#433) Some minor doc updates to reword or remove things that don't make sense in the context of the public library. --- _By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_ --- API.md | 281 +++++++----------- lib/common/alarm/AlarmFactory.ts | 6 +- lib/common/alarm/CustomAlarmThreshold.ts | 5 +- lib/dashboard/widget/BitmapWidget.ts | 2 +- .../SecretsManagerMetricsPublisher.ts | 2 +- .../__snapshots__/BitmapWidget.test.ts.snap | 2 +- .../MonitoringAspect.test.ts.snap | 2 +- ...ecretsManagerSecretMonitoring.test.ts.snap | 4 +- 8 files changed, 124 insertions(+), 180 deletions(-) diff --git a/API.md b/API.md index 6f2055ba..06b417d7 100644 --- a/API.md +++ b/API.md @@ -2455,7 +2455,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -2508,7 +2508,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -3244,7 +3244,7 @@ public readonly alarmNamePrefix: string; Global prefix for all alarm names. -This should be something unique to avoid collisions with other CTIs. +This should be something unique to avoid potential collisions. This is ignored if an alarm's dedupeStringOverride is declared. --- @@ -4035,7 +4035,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -4102,8 +4102,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -7504,7 +7503,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -7571,8 +7570,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -8944,7 +8942,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -9011,8 +9009,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -10144,7 +10141,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -10211,8 +10208,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -10481,7 +10477,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -10548,8 +10544,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -12044,7 +12039,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -12111,8 +12106,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -12548,7 +12542,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -12615,8 +12609,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -12884,7 +12877,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -12951,8 +12944,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -13645,7 +13637,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -13712,8 +13704,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -16538,7 +16529,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -16605,8 +16596,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -16874,7 +16864,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -16941,8 +16931,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -18074,7 +18063,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -18141,8 +18130,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -18412,7 +18400,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -18479,8 +18467,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -19166,7 +19153,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -19233,8 +19220,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -19502,7 +19488,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -19569,8 +19555,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -19838,7 +19823,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -19905,8 +19890,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -20174,7 +20158,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -20241,8 +20225,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -20510,7 +20493,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -20577,8 +20560,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -22764,7 +22746,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -22831,8 +22813,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -23100,7 +23081,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -23167,8 +23148,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -23625,7 +23605,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -23692,8 +23672,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -23961,7 +23940,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -24028,8 +24007,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -24297,7 +24275,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -24364,8 +24342,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -24633,7 +24610,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -24700,8 +24677,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -24969,7 +24945,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -25036,8 +25012,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -25305,7 +25280,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -25372,8 +25347,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -25641,7 +25615,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -25708,8 +25682,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -25977,7 +25950,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -26044,8 +26017,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -26313,7 +26285,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -26380,8 +26352,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -26649,7 +26620,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -26716,8 +26687,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -26985,7 +26955,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -27052,8 +27022,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -27321,7 +27290,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -27388,8 +27357,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -27657,7 +27625,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -27724,8 +27692,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -28105,7 +28072,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -28172,8 +28139,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -28441,7 +28407,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -28508,8 +28474,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -28777,7 +28742,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -28844,8 +28809,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -29113,7 +29077,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -29180,8 +29144,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -29451,7 +29414,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -29518,8 +29481,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -29787,7 +29749,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -29854,8 +29816,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -30123,7 +30084,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -30190,8 +30151,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -31572,7 +31532,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -31639,8 +31599,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -31908,7 +31867,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -31975,8 +31934,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -32244,7 +32202,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -32311,8 +32269,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -33285,7 +33242,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -33352,8 +33309,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -33621,7 +33577,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -33688,8 +33644,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -33957,7 +33912,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -34024,8 +33979,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -34293,7 +34247,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -34360,8 +34314,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -35366,7 +35319,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -35433,8 +35386,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -35702,7 +35654,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -35769,8 +35721,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -36431,7 +36382,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -36498,8 +36449,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -36767,7 +36717,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -36834,8 +36784,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -41349,7 +41298,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -41416,8 +41365,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -41685,7 +41633,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -41752,8 +41700,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -42021,7 +41968,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -42088,8 +42035,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -42357,7 +42303,7 @@ public readonly alarmNameOverride: string; If this is defined, the alarm name is set to this exact value. -Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. +Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- @@ -42424,8 +42370,7 @@ public readonly dedupeStringOverride: string; If this is defined, the alarm dedupe string is set to this exact value. -Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. -Dedupe strings are global and not unique per CTI. +Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- diff --git a/lib/common/alarm/AlarmFactory.ts b/lib/common/alarm/AlarmFactory.ts index ef879d7f..f2f167a0 100644 --- a/lib/common/alarm/AlarmFactory.ts +++ b/lib/common/alarm/AlarmFactory.ts @@ -77,7 +77,7 @@ export interface AddAlarmProps { /** * If this is defined, the alarm dedupe string is set to this exact value. - * Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. + * Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. * * @default - undefined (no override) */ @@ -85,7 +85,7 @@ export interface AddAlarmProps { /** * If this is defined, the alarm name is set to this exact value. - * Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. + * Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. */ readonly alarmNameOverride?: string; @@ -436,7 +436,7 @@ export interface AlarmFactoryDefaults { readonly evaluationPeriods?: number; /** - * Global prefix for all alarm names. This should be something unique to avoid collisions with other CTIs. + * Global prefix for all alarm names. This should be something unique to avoid potential collisions. * This is ignored if an alarm's dedupeStringOverride is declared. */ readonly alarmNamePrefix: string; diff --git a/lib/common/alarm/CustomAlarmThreshold.ts b/lib/common/alarm/CustomAlarmThreshold.ts index c4896425..4bf83700 100644 --- a/lib/common/alarm/CustomAlarmThreshold.ts +++ b/lib/common/alarm/CustomAlarmThreshold.ts @@ -20,8 +20,7 @@ export interface CustomAlarmThreshold { /** * If this is defined, the alarm dedupe string is set to this exact value. - * Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually. - * Dedupe strings are global and not unique per CTI. + * Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. * * @default - undefined (no override) */ @@ -29,7 +28,7 @@ export interface CustomAlarmThreshold { /** * If this is defined, the alarm name is set to this exact value. - * Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually. + * Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. */ readonly alarmNameOverride?: string; diff --git a/lib/dashboard/widget/BitmapWidget.ts b/lib/dashboard/widget/BitmapWidget.ts index 7cfbcd26..d8b3da91 100644 --- a/lib/dashboard/widget/BitmapWidget.ts +++ b/lib/dashboard/widget/BitmapWidget.ts @@ -31,7 +31,7 @@ export class BitmapWidgetRenderingSupport extends Construct { ) ), description: - "Custom Widget Render for Bitmap Widgets (MonitoringCDKConstructs)", + "Custom Widget Render for Bitmap Widgets (cdk-monitoring-constructs)", handler: "index.handler", memorySize: 128, runtime: Runtime.NODEJS_18_X, diff --git a/lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher.ts b/lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher.ts index b7038f1a..e9517799 100644 --- a/lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher.ts +++ b/lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher.ts @@ -31,7 +31,7 @@ export class SecretsManagerMetricsPublisher extends Construct { ) ), description: - "Custom metrics publisher for SecretsManager Secrets (MonitoringCDKConstructs)", + "Custom metrics publisher for SecretsManager Secrets (cdk-monitoring-constructs)", handler: "index.handler", memorySize: 128, runtime: Runtime.NODEJS_18_X, diff --git a/test/dashboard/widget/__snapshots__/BitmapWidget.test.ts.snap b/test/dashboard/widget/__snapshots__/BitmapWidget.test.ts.snap index 5d9aac16..0e850d67 100644 --- a/test/dashboard/widget/__snapshots__/BitmapWidget.test.ts.snap +++ b/test/dashboard/widget/__snapshots__/BitmapWidget.test.ts.snap @@ -100,7 +100,7 @@ Object { }, "S3Key": "Fixed key that does not depend on asset changes", }, - "Description": "Custom Widget Render for Bitmap Widgets (MonitoringCDKConstructs)", + "Description": "Custom Widget Render for Bitmap Widgets (cdk-monitoring-constructs)", "Handler": "index.handler", "MemorySize": 128, "Role": Object { diff --git a/test/facade/__snapshots__/MonitoringAspect.test.ts.snap b/test/facade/__snapshots__/MonitoringAspect.test.ts.snap index 1c6481d9..eac65ba4 100644 --- a/test/facade/__snapshots__/MonitoringAspect.test.ts.snap +++ b/test/facade/__snapshots__/MonitoringAspect.test.ts.snap @@ -3451,7 +3451,7 @@ Object { }, "S3Key": "d06eb8bb6deb3dba48c714538958f2ea17e2418a079ef471cb5b7b9de6a29d18.zip", }, - "Description": "Custom metrics publisher for SecretsManager Secrets (MonitoringCDKConstructs)", + "Description": "Custom metrics publisher for SecretsManager Secrets (cdk-monitoring-constructs)", "Handler": "index.handler", "MemorySize": 128, "Role": Object { diff --git a/test/monitoring/aws-secretsmanager/__snapshots__/SecretsManagerSecretMonitoring.test.ts.snap b/test/monitoring/aws-secretsmanager/__snapshots__/SecretsManagerSecretMonitoring.test.ts.snap index 40411d4a..8d11cb14 100644 --- a/test/monitoring/aws-secretsmanager/__snapshots__/SecretsManagerSecretMonitoring.test.ts.snap +++ b/test/monitoring/aws-secretsmanager/__snapshots__/SecretsManagerSecretMonitoring.test.ts.snap @@ -100,7 +100,7 @@ Object { }, "S3Key": "Fixed key that does not depend on asset changes", }, - "Description": "Custom metrics publisher for SecretsManager Secrets (MonitoringCDKConstructs)", + "Description": "Custom metrics publisher for SecretsManager Secrets (cdk-monitoring-constructs)", "Handler": "index.handler", "MemorySize": 128, "Role": Object { @@ -426,7 +426,7 @@ Object { }, "S3Key": "Fixed key that does not depend on asset changes", }, - "Description": "Custom metrics publisher for SecretsManager Secrets (MonitoringCDKConstructs)", + "Description": "Custom metrics publisher for SecretsManager Secrets (cdk-monitoring-constructs)", "Handler": "index.handler", "MemorySize": 128, "Role": Object {