software.amazon.awscdk.services.cloudwatch

Class GraphWidgetProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.GraphWidgetProps.Builder

Enclosing interface:

GraphWidgetProps

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

A builder for GraphWidgetProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GraphWidgetProps	build() Builds the configured instance.
GraphWidgetProps.Builder	withHeight(Number value) Sets the value of Height
GraphWidgetProps.Builder	withLeft(List<IMetric> value) Sets the value of Left
GraphWidgetProps.Builder	withLeftAnnotations(List<HorizontalAnnotation> value) Sets the value of LeftAnnotations
GraphWidgetProps.Builder	withLeftYAxis(YAxisProps value) Sets the value of LeftYAxis
GraphWidgetProps.Builder	withRegion(String value) Sets the value of Region
GraphWidgetProps.Builder	withRight(List<IMetric> value) Sets the value of Right
GraphWidgetProps.Builder	withRightAnnotations(List<HorizontalAnnotation> value) Sets the value of RightAnnotations
GraphWidgetProps.Builder	withRightYAxis(YAxisProps value) Sets the value of RightYAxis
GraphWidgetProps.Builder	withStacked(Boolean value) Sets the value of Stacked
GraphWidgetProps.Builder	withTitle(String value) Sets the value of Title
GraphWidgetProps.Builder	withWidth(Number value) Sets the value of Width

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

withLeft

@Stability(value=Experimental)
public GraphWidgetProps.Builder withLeft(@Nullable
                                                                        List<IMetric> value)

Sets the value of Left

Parameters:

value - Metrics to display on left Y axis.

Returns:

this

withLeftAnnotations

@Stability(value=Experimental)
public GraphWidgetProps.Builder withLeftAnnotations(@Nullable
                                                                                   List<HorizontalAnnotation> value)

Sets the value of LeftAnnotations

Parameters:

value - Annotations for the left Y axis.

Returns:

this

withLeftYAxis

@Stability(value=Experimental)
public GraphWidgetProps.Builder withLeftYAxis(@Nullable
                                                                             YAxisProps value)

Sets the value of LeftYAxis

Parameters:

value - Left Y axis.

Returns:

this

withRight

@Stability(value=Experimental)
public GraphWidgetProps.Builder withRight(@Nullable
                                                                         List<IMetric> value)

Sets the value of Right

Parameters:

value - Metrics to display on right Y axis.

Returns:

this

withRightAnnotations

@Stability(value=Experimental)
public GraphWidgetProps.Builder withRightAnnotations(@Nullable
                                                                                    List<HorizontalAnnotation> value)

Sets the value of RightAnnotations

Parameters:

value - Annotations for the right Y axis.

Returns:

this

withRightYAxis

@Stability(value=Experimental)
public GraphWidgetProps.Builder withRightYAxis(@Nullable
                                                                              YAxisProps value)

Sets the value of RightYAxis

Parameters:

value - Right Y axis.

Returns:

this

withStacked

@Stability(value=Experimental)
public GraphWidgetProps.Builder withStacked(@Nullable
                                                                           Boolean value)

Sets the value of Stacked

Parameters:

value - Whether the graph should be shown as stacked lines.

Returns:

this

withHeight

@Stability(value=Experimental)
public GraphWidgetProps.Builder withHeight(@Nullable
                                                                          Number value)

Sets the value of Height

Parameters:

value - Height of the widget.

Returns:

this

withRegion

@Stability(value=Experimental)
public GraphWidgetProps.Builder withRegion(@Nullable
                                                                          String value)

Sets the value of Region

Parameters:

value - The region the metrics of this graph should be taken from.

Returns:

this

withTitle

@Stability(value=Experimental)
public GraphWidgetProps.Builder withTitle(@Nullable
                                                                         String value)

Sets the value of Title

Parameters:

value - Title for the graph.

Returns:

this

withWidth

@Stability(value=Experimental)
public GraphWidgetProps.Builder withWidth(@Nullable
                                                                         Number value)

Sets the value of Width

Parameters:

value - Width of the widget, in a grid of 24 units wide.

Returns:

this

build

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

Builds the configured instance.

Returns:

a new instance of GraphWidgetProps

Throws:

NullPointerException - if any required attribute was not provided