software.amazon.awscdk.services.cloudwatch

Interface DashboardProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DashboardProps.Jsii$Proxy

@Generated(value="jsii-pacmak/0.13.2 (build a2116e9)",
           date="2019-07-01T16:58:11.753Z")
 @Stability(value=Experimental)
public interface DashboardProps
extends software.amazon.jsii.JsiiSerializable

EXPERIMENTAL

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DashboardProps.Builder A builder for DashboardProps
static class	DashboardProps.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
static DashboardProps.Builder	builder()
String	getDashboardName() Name of the dashboard.
String	getEnd() The end of the time range to use for each widget on the dashboard when the dashboard loads.
PeriodOverride	getPeriodOverride() Use this field to specify the period for the graphs when the dashboard loads.
String	getStart() The start of the time range to use for each widget on the dashboard.
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=Experimental)
String getDashboardName()

Name of the dashboard. Default: Automatically generated name EXPERIMENTAL

getEnd

@Stability(value=Experimental)
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. EXPERIMENTAL

getPeriodOverride

@Stability(value=Experimental)
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 EXPERIMENTAL

getStart

@Stability(value=Experimental)
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. EXPERIMENTAL

getWidgets

@Stability(value=Experimental)
List<List<IWidget>> getWidgets()

Initial set of widgets on the dashboard. One array represents a row of widgets. Default: - No widgets EXPERIMENTAL

builder

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

Returns:

a DashboardProps.Builder of DashboardProps