DashboardProps Struct
Properties for defining a CloudWatch Dashboard.
Example
import * as cw from 'aws-cdk-lib/aws-cloudwatch';
const dashboard = new cw.Dashboard(this, 'Dash', {
defaultInterval: Duration.days(7),
variables: [new cw.DashboardVariable({
id: 'region2',
type: cw.VariableType.PATTERN,
label: 'RegionPattern',
inputType: cw.VariableInputType.INPUT,
value: 'us-east-1',
defaultValue: cw.DefaultValue.value('us-east-1'),
visible: true,
})],
});
Properties
dashboardNameoptionalstringdashboard_nameoptionalstrdashboardNameoptionalStringDashboardNameoptionalstringDashboardNameoptional*string#Default: automatically generated name
If set, must only contain alphanumerics, dash (-) and underscore (_)
defaultIntervaloptionalDurationdefault_intervaloptionalDurationdefaultIntervaloptionalDurationDefaultIntervaloptionalDurationDefaultIntervaloptionalDuration#Default: When the dashboard loads, the defaultInterval time will be the default time range.
Both properties defaultInterval and start cannot be set at once.
Default: When the dashboard loads, the end date will be the current time.
If you specify a value for end, you must also specify a value for start. Specify an absolute time in the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.
periodOverrideoptionalPeriodOverrideperiod_overrideoptionalPeriodOverrideperiodOverrideoptionalPeriodOverridePeriodOverrideoptionalPeriodOverridePeriodOverrideoptionalPeriodOverride= Auto#Specifying Auto causes the period of all graphs on the dashboard to automatically adapt to the time range of the dashboard. Specifying Inherit ensures that the period set for each graph is always obeyed.
Default: When the dashboard loads, the start time will be the default time range.
notes
You can specify start without specifying end to specify a relative time range that ends with the current time. In this case, the value of start must begin with -P, and you can use M, H, D, W and M as abbreviations for minutes, hours, days, weeks and months. For example, -PT8H shows the last 8 hours and -P3M shows the last three months. You can also use start along with an end field, to specify an absolute time range. When specifying an absolute time range, use the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.
Both properties defaultInterval and start cannot be set at once.