software.amazon.awscdk.services.cloudwatch

Interface DashboardProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DashboardProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:51.272Z")
 @Stability(value=Stable)
public interface DashboardProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CloudWatch Dashboard.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudwatch.*;
 IWidget widget;
 DashboardProps dashboardProps = DashboardProps.builder()
         .dashboardName("dashboardName")
         .end("end")
         .periodOverride(PeriodOverride.AUTO)
         .start("start")
         .widgets(List.of(List.of(widget)))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DashboardProps.Builder A builder for DashboardProps
static class	DashboardProps.Jsii$Proxy An implementation for DashboardProps

Method Summary

Modifier and Type	Method and Description
static DashboardProps.Builder	builder()
default String	getDashboardName() Name of the dashboard.
default String	getEnd() The end of the time range to use for each widget on the dashboard when the dashboard loads.
default PeriodOverride	getPeriodOverride() Use this field to specify the period for the graphs when the dashboard loads.
default String	getStart() The start of the time range to use for each widget on the dashboard.
default List<List<IWidget>>	getWidgets() Initial set of widgets on the dashboard.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDashboardName

@Stability(value=Stable)
 @Nullable
default String getDashboardName()

Name of the dashboard.

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

Default: - automatically generated name

getEnd

@Stability(value=Stable)
 @Nullable
default String getEnd()

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.

getPeriodOverride

@Stability(value=Stable)
 @Nullable
default PeriodOverride getPeriodOverride()

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

getStart

@Stability(value=Stable)
 @Nullable
default String getStart()

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.

getWidgets

@Stability(value=Stable)
 @Nullable
default List<List<IWidget>> getWidgets()

Initial set of widgets on the dashboard.

One array represents a row of widgets.

Default: - No widgets

builder

@Stability(value=Stable)
static DashboardProps.Builder builder()

Returns:

a DashboardProps.Builder of DashboardProps