Skip to content

Commit 064d54f

Browse files
author
Eugene Cheung
authored
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_
1 parent dadff59 commit 064d54f

File tree

8 files changed

+124
-180
lines changed

8 files changed

+124
-180
lines changed

API.md

Lines changed: 113 additions & 168 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/common/alarm/AlarmFactory.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,15 +77,15 @@ export interface AddAlarmProps {
7777

7878
/**
7979
* If this is defined, the alarm dedupe string is set to this exact value.
80-
* Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually.
80+
* Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually.
8181
*
8282
* @default - undefined (no override)
8383
*/
8484
readonly dedupeStringOverride?: string;
8585

8686
/**
8787
* If this is defined, the alarm name is set to this exact value.
88-
* Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually.
88+
* Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually.
8989
*/
9090
readonly alarmNameOverride?: string;
9191

@@ -436,7 +436,7 @@ export interface AlarmFactoryDefaults {
436436
readonly evaluationPeriods?: number;
437437

438438
/**
439-
* Global prefix for all alarm names. This should be something unique to avoid collisions with other CTIs.
439+
* Global prefix for all alarm names. This should be something unique to avoid potential collisions.
440440
* This is ignored if an alarm's dedupeStringOverride is declared.
441441
*/
442442
readonly alarmNamePrefix: string;

lib/common/alarm/CustomAlarmThreshold.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,15 @@ export interface CustomAlarmThreshold {
2020

2121
/**
2222
* If this is defined, the alarm dedupe string is set to this exact value.
23-
* Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually.
24-
* Dedupe strings are global and not unique per CTI.
23+
* Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually.
2524
*
2625
* @default - undefined (no override)
2726
*/
2827
readonly dedupeStringOverride?: string;
2928

3029
/**
3130
* If this is defined, the alarm name is set to this exact value.
32-
* Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually.
31+
* Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually.
3332
*/
3433
readonly alarmNameOverride?: string;
3534

lib/dashboard/widget/BitmapWidget.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export class BitmapWidgetRenderingSupport extends Construct {
3131
)
3232
),
3333
description:
34-
"Custom Widget Render for Bitmap Widgets (MonitoringCDKConstructs)",
34+
"Custom Widget Render for Bitmap Widgets (cdk-monitoring-constructs)",
3535
handler: "index.handler",
3636
memorySize: 128,
3737
runtime: Runtime.NODEJS_18_X,

lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export class SecretsManagerMetricsPublisher extends Construct {
3131
)
3232
),
3333
description:
34-
"Custom metrics publisher for SecretsManager Secrets (MonitoringCDKConstructs)",
34+
"Custom metrics publisher for SecretsManager Secrets (cdk-monitoring-constructs)",
3535
handler: "index.handler",
3636
memorySize: 128,
3737
runtime: Runtime.NODEJS_18_X,

test/dashboard/widget/__snapshots__/BitmapWidget.test.ts.snap

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

test/facade/__snapshots__/MonitoringAspect.test.ts.snap

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

test/monitoring/aws-secretsmanager/__snapshots__/SecretsManagerSecretMonitoring.test.ts.snap

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)