software.amazon.awscdk.services.cloudwatch

Class DashboardProps.Builder

java.lang.Object

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

Enclosing interface:

DashboardProps

@Stability(value=Experimental)
public static final class DashboardProps.Builder
extends Object

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	withDashboardName(String value) Sets the value of DashboardName
DashboardProps.Builder	withEnd(String value) Sets the value of End
DashboardProps.Builder	withPeriodOverride(PeriodOverride value) Sets the value of PeriodOverride
DashboardProps.Builder	withStart(String value) Sets the value of Start
DashboardProps.Builder	withWidgets(List<List<IWidget>> value) Sets the value of Widgets

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

withDashboardName

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

Sets the value of DashboardName

Parameters:

value - Name of the dashboard.

Returns:

this

withEnd

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

Sets the value of End

Parameters:

value - 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

withPeriodOverride

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

Sets the value of PeriodOverride

Parameters:

value - 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

withStart

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

Sets the value of Start

Parameters:

value - 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

withWidgets

@Stability(value=Experimental)
public DashboardProps.Builder withWidgets(@Nullable
                                                                         List<List<IWidget>> value)

Sets the value of Widgets

Parameters:

value - Initial set of widgets on the dashboard.

Returns:

this

build

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

Builds the configured instance.

Returns:

a new instance of DashboardProps

Throws:

NullPointerException - if any required attribute was not provided