class aws_cdk.aws_cloudwatch.Dashboard(scope, id, *, dashboard_name=None, end=None, period_override=None, start=None, widgets=None)

Bases: aws_cdk.core.Resource

A CloudWatch dashboard.

  • scope (Construct) –

  • id (str) –

  • dashboard_name (Optional[str]) – Name of the dashboard. If set, must only contain alphanumerics, dash (-) and underscore (_) Default: - automatically generated name

  • end (Optional[str]) – The end of the time range to use for each widget on the dashboard when the dashboard loads. 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. Default: When the dashboard loads, the end date will be the current time.

  • period_override (Optional[PeriodOverride]) – Use this field to specify the period for the graphs when the dashboard loads. 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: Auto

  • start (Optional[str]) – The start of the time range to use for each widget on the dashboard. 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. Default: When the dashboard loads, the start time will be the default time range.

  • widgets (Optional[Sequence[Sequence[IWidget]]]) – Initial set of widgets on the dashboard. One array represents a row of widgets. Default: - No widgets



Add a widget to the dashboard.

Widgets given in multiple calls to add() will be laid out stacked on top of each other.

Multiple widgets added in the same call to add() will be laid out next to each other.


widgets (IWidget) –

Return type



Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


policy (RemovalPolicy) –

Return type



Returns a string representation of this construct.

Return type




The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type



The construct tree node associated with this construct.

Return type



The stack in which this resource is defined.

Return type


Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.


x (Any) –

Return type


classmethod is_resource(construct)

Check whether the given construct is a Resource.


construct (IConstruct) –

Return type