software.amazon.awscdk.services.cloudwatch

Class AlarmWidget.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.AlarmWidget.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AlarmWidget>

Enclosing class:

AlarmWidget

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

(experimental) A fluent builder for AlarmWidget.

Method Summary

Modifier and Type	Method and Description
AlarmWidget.Builder	alarm(IAlarm alarm) (experimental) The alarm to show.
AlarmWidget	build()
static AlarmWidget.Builder	create()
AlarmWidget.Builder	height(Number height) (experimental) Height of the widget.
AlarmWidget.Builder	leftYAxis(YAxisProps leftYAxis) (experimental) Left Y axis.
AlarmWidget.Builder	region(String region) (experimental) The region the metrics of this graph should be taken from.
AlarmWidget.Builder	title(String title) (experimental) Title for the graph.
AlarmWidget.Builder	width(Number width) (experimental) Width of the widget, in a grid of 24 units wide.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static AlarmWidget.Builder create()

Returns:

a new instance of AlarmWidget.Builder.

height

@Stability(value=Experimental)
public AlarmWidget.Builder height(Number height)

(experimental) Height of the widget.

Default: - 6 for Alarm and Graph widgets. 3 for single value widgets where most recent value of a metric is displayed.

Parameters:

height - Height of the widget. This parameter is required.

Returns:

this

region

@Stability(value=Experimental)
public AlarmWidget.Builder region(String region)

(experimental) The region the metrics of this graph should be taken from.

Default: - Current region

Parameters:

region - The region the metrics of this graph should be taken from. This parameter is required.

Returns:

this

title

@Stability(value=Experimental)
public AlarmWidget.Builder title(String title)

(experimental) Title for the graph.

Default: - None

Parameters:

title - Title for the graph. This parameter is required.

Returns:

this

width

@Stability(value=Experimental)
public AlarmWidget.Builder width(Number width)

(experimental) Width of the widget, in a grid of 24 units wide.

Default: 6

Parameters:

width - Width of the widget, in a grid of 24 units wide. This parameter is required.

Returns:

this

alarm

@Stability(value=Experimental)
public AlarmWidget.Builder alarm(IAlarm alarm)

(experimental) The alarm to show.

Parameters:

alarm - The alarm to show. This parameter is required.

Returns:

this

leftYAxis

@Stability(value=Experimental)
public AlarmWidget.Builder leftYAxis(YAxisProps leftYAxis)

(experimental) Left Y axis.

Default: - No minimum or maximum values for the left Y-axis

Parameters:

leftYAxis - Left Y axis. This parameter is required.

Returns:

this

build

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

Specified by:

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