software.amazon.awscdk.services.cloudwatch

Interface GraphWidgetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, MetricWidgetProps

All Known Implementing Classes:

GraphWidgetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:51.274Z")
 @Stability(value=Stable)
public interface GraphWidgetProps
extends software.amazon.jsii.JsiiSerializable, MetricWidgetProps

Properties for a GraphWidget.

Example:

 Dashboard dashboard;
 dashboard.addWidgets(GraphWidget.Builder.create()
         // ...
         .legendPosition(LegendPosition.RIGHT)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GraphWidgetProps.Builder A builder for GraphWidgetProps
static class	GraphWidgetProps.Jsii$Proxy An implementation for GraphWidgetProps

Method Summary

Modifier and Type	Method and Description
static GraphWidgetProps.Builder	builder()
default List<IMetric>	getLeft() Metrics to display on left Y axis.
default List<HorizontalAnnotation>	getLeftAnnotations() Annotations for the left Y axis.
default YAxisProps	getLeftYAxis() Left Y axis.
default LegendPosition	getLegendPosition() Position of the legend.
default Boolean	getLiveData() Whether the graph should show live data.
default Duration	getPeriod() The default period for all metrics in this widget.
default List<IMetric>	getRight() Metrics to display on right Y axis.
default List<HorizontalAnnotation>	getRightAnnotations() Annotations for the right Y axis.
default YAxisProps	getRightYAxis() Right Y axis.
default Boolean	getSetPeriodToTimeRange() Whether to show the value from the entire time range.
default Boolean	getStacked() Whether the graph should be shown as stacked lines.
default String	getStatistic() The default statistic to be displayed for each metric.
default GraphWidgetView	getView() Display this metric.

Methods inherited from interface software.amazon.awscdk.services.cloudwatch.MetricWidgetProps

getHeight, getRegion, getTitle, getWidth

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getLeft

@Stability(value=Stable)
 @Nullable
default List<IMetric> getLeft()

Metrics to display on left Y axis.

Default: - No metrics

getLeftAnnotations

@Stability(value=Stable)
 @Nullable
default List<HorizontalAnnotation> getLeftAnnotations()

Annotations for the left Y axis.

Default: - No annotations

getLeftYAxis

@Stability(value=Stable)
 @Nullable
default YAxisProps getLeftYAxis()

Left Y axis.

Default: - None

getLegendPosition

@Stability(value=Stable)
 @Nullable
default LegendPosition getLegendPosition()

Position of the legend.

Default: - bottom

getLiveData

@Stability(value=Stable)
 @Nullable
default Boolean getLiveData()

Whether the graph should show live data.

Default: false

getPeriod

@Stability(value=Stable)
 @Nullable
default Duration getPeriod()

The default period for all metrics in this widget.

The period is the length of time represented by one data point on the graph. This default can be overridden within each metric definition.

Default: cdk.Duration.seconds(300)

getRight

@Stability(value=Stable)
 @Nullable
default List<IMetric> getRight()

Metrics to display on right Y axis.

Default: - No metrics

getRightAnnotations

@Stability(value=Stable)
 @Nullable
default List<HorizontalAnnotation> getRightAnnotations()

Annotations for the right Y axis.

Default: - No annotations

getRightYAxis

@Stability(value=Stable)
 @Nullable
default YAxisProps getRightYAxis()

Right Y axis.

Default: - None

getSetPeriodToTimeRange

@Stability(value=Stable)
 @Nullable
default Boolean getSetPeriodToTimeRange()

Whether to show the value from the entire time range. Only applicable for Bar and Pie charts.

If false, values will be from the most recent period of your chosen time range; if true, shows the value from the entire time range.

Default: false

getStacked

@Stability(value=Stable)
 @Nullable
default Boolean getStacked()

Whether the graph should be shown as stacked lines.

Default: false

getStatistic

@Stability(value=Stable)
 @Nullable
default String getStatistic()

The default statistic to be displayed for each metric.

This default can be overridden within the definition of each individual metric

Default: - The statistic for each metric is used

getView

@Stability(value=Stable)
 @Nullable
default GraphWidgetView getView()

Display this metric.

Default: TimeSeries

builder

@Stability(value=Stable)
static GraphWidgetProps.Builder builder()

Specified by:

builder in interface MetricWidgetProps

Returns:

a GraphWidgetProps.Builder of GraphWidgetProps