Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update some docs #433

Merged
merged 1 commit into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
281 changes: 113 additions & 168 deletions API.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions lib/common/alarm/AlarmFactory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,15 @@ 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)
*/
readonly dedupeStringOverride?: 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.
*/
readonly alarmNameOverride?: string;

Expand Down Expand Up @@ -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;
Expand Down
5 changes: 2 additions & 3 deletions lib/common/alarm/CustomAlarmThreshold.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,15 @@ 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)
*/
readonly dedupeStringOverride?: 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.
*/
readonly alarmNameOverride?: string;

Expand Down
2 changes: 1 addition & 1 deletion lib/dashboard/widget/BitmapWidget.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion test/facade/__snapshots__/MonitoringAspect.test.ts.snap

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.