DashboardProps

class aws_cdk.aws_cloudwatch.DashboardProps(*, dashboard_name=None, default_interval=None, end=None, period_override=None, start=None, variables=None, widgets=None)

Bases: object

Properties for defining a CloudWatch Dashboard.

Parameters:

dashboard_name (Optional[str]) – Name of the dashboard. If set, must only contain alphanumerics, dash (-) and underscore (_) Default: - automatically generated name
default_interval (Optional[Duration]) – Interval duration for metrics. You can specify defaultInterval with the relative time(eg. cdk.Duration.days(7)). Both properties defaultInterval and start cannot be set at once. Default: When the dashboard loads, the defaultInterval time will be the default time range.
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. Both properties defaultInterval and start cannot be set at once. Default: When the dashboard loads, the start time will be the default time range.
variables (Optional[Sequence[IVariable]]) – A list of dashboard variables. Default: - No variables
widgets (Optional[Sequence[Sequence[IWidget]]]) – Initial set of widgets on the dashboard. One array represents a row of widgets. Default: - No widgets

ExampleMetadata:

infused

Example:

import aws_cdk.aws_cloudwatch as cw


dashboard = cw.Dashboard(self, "Dash",
    default_interval=Duration.days(7),
    variables=[cw.DashboardVariable(
        id="region2",
        type=cw.VariableType.PATTERN,
        label="RegionPattern",
        input_type=cw.VariableInputType.INPUT,
        value="us-east-1",
        default_value=cw.DefaultValue.value("us-east-1"),
        visible=True
    )]
)

Attributes

dashboard_name

Name of the dashboard.

If set, must only contain alphanumerics, dash (-) and underscore (_)

Default:

automatically generated name

default_interval

Interval duration for metrics. You can specify defaultInterval with the relative time(eg. cdk.Duration.days(7)).

Both properties defaultInterval and start cannot be set at once.

Default:: When the dashboard loads, the defaultInterval time will be the default time range.

end

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

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

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.

Both properties defaultInterval and start cannot be set at once.

Default:: When the dashboard loads, the start time will be the default time range.

variables

A list of dashboard variables.

Default:

No variables

See:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_dashboard_variables.html#cloudwatch_dashboard_variables_types

widgets

Initial set of widgets on the dashboard.

One array represents a row of widgets.

Default:

No widgets