software.amazon.awscdk.services.cloudwatch

Class DashboardProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.DashboardProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DashboardProps>

Enclosing interface:

DashboardProps

@Stability(value=Experimental)
public static final class DashboardProps.Builder
extends Object
implements software.amazon.jsii.Builder<DashboardProps>

A builder for DashboardProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DashboardProps	build() Builds the configured instance.
DashboardProps.Builder	dashboardName(String dashboardName) Sets the value of DashboardProps.getDashboardName()
DashboardProps.Builder	end(String end) Sets the value of DashboardProps.getEnd()
DashboardProps.Builder	periodOverride(PeriodOverride periodOverride) Sets the value of DashboardProps.getPeriodOverride()
DashboardProps.Builder	start(String start) Sets the value of DashboardProps.getStart()
DashboardProps.Builder	widgets(List<? extends List<? extends IWidget>> widgets) Sets the value of DashboardProps.getWidgets()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

dashboardName

@Stability(value=Experimental)
public DashboardProps.Builder dashboardName(String dashboardName)

Sets the value of DashboardProps.getDashboardName()

Parameters:

dashboardName - Name of the dashboard. If set, must only contain alphanumerics, dash (-) and underscore (_)

Returns:

this

end

@Stability(value=Experimental)
public DashboardProps.Builder end(String end)

Sets the value of DashboardProps.getEnd()

Parameters:

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.

Returns:

this

periodOverride

@Stability(value=Experimental)
public DashboardProps.Builder periodOverride(PeriodOverride periodOverride)

Sets the value of DashboardProps.getPeriodOverride()

Parameters:

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.

Returns:

this

start

@Stability(value=Experimental)
public DashboardProps.Builder start(String start)

Sets the value of DashboardProps.getStart()

Parameters:

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.

Returns:

this

widgets

@Stability(value=Experimental)
public DashboardProps.Builder widgets(List<? extends List<? extends IWidget>> widgets)

Sets the value of DashboardProps.getWidgets()

Parameters:

widgets - Initial set of widgets on the dashboard. One array represents a row of widgets.

Returns:

this

build

@Stability(value=Experimental)
public DashboardProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<DashboardProps>

Returns:

a new instance of DashboardProps

Throws:

NullPointerException - if any required attribute was not provided