Header menu logo FsCDK

DashboardConfig Type

High-level CloudWatch Dashboard builder following AWS monitoring best practices. **Default Settings:** - Dashboard name = construct name - Period for metrics = 5 minutes (good balance of granularity and cost) - Widgets arranged in rows and columns **Rationale:** These defaults follow AWS Well-Architected Framework operational excellence pillar: - Clear dashboard names improve discoverability - 5-minute periods provide good visibility without excessive cost - Structured layout improves readability **Best Practices:** - Organize related metrics together - Use alarms to highlight critical issues - Include both system and business metrics - Set appropriate Y-axis ranges for clarity **Escape Hatch:** Access the underlying CDK Dashboard via the `Dashboard` property for advanced scenarios not covered by this builder.

Record fields

Record Field Description

ConstructId

Full Usage: ConstructId

Field type: string option
Field type: string option

DefaultInterval

Full Usage: DefaultInterval

Field type: Duration option
Field type: Duration option

End

Full Usage: End

Field type: string option
Field type: string option

PeriodOverride

Full Usage: PeriodOverride

Field type: PeriodOverride option
Field type: PeriodOverride option

Start

Full Usage: Start

Field type: string option
Field type: string option

Variables

Full Usage: Variables

Field type: IVariable seq
Field type: IVariable seq

Widgets

Full Usage: Widgets

Field type: IWidget seq seq
Field type: IWidget seq seq

Type something to start searching.