Dashboard

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.

__init__(scope, id, *, dashboard_name=None, end=None, period_override=None, start=None, widgets=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • props

  • 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[List[List[IWidget]]]) – Initial set of widgets on the dashboard. One array represents a row of widgets. Default: - No widgets

Return type

None

Methods

add_widgets(*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.

Parameters

widgets (IWidget) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool