Class GaugeWidgetProps.Builder
java.lang.Object
software.amazon.awscdk.services.cloudwatch.GaugeWidgetProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<GaugeWidgetProps>
- Enclosing interface:
- GaugeWidgetProps
@Stability(Stable)
public static final class GaugeWidgetProps.Builder
extends Object
implements software.amazon.jsii.Builder<GaugeWidgetProps>
A builder for
GaugeWidgetProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionannotations
(List<? extends HorizontalAnnotation> annotations) Sets the value ofGaugeWidgetProps.getAnnotations()
build()
Builds the configured instance.Sets the value ofGaugeWidgetProps.getEnd()
Sets the value ofMetricWidgetProps.getHeight()
leftYAxis
(YAxisProps leftYAxis) Sets the value ofGaugeWidgetProps.getLeftYAxis()
legendPosition
(LegendPosition legendPosition) Sets the value ofGaugeWidgetProps.getLegendPosition()
Sets the value ofGaugeWidgetProps.getLiveData()
Sets the value ofGaugeWidgetProps.getMetrics()
Sets the value ofGaugeWidgetProps.getPeriod()
Sets the value ofMetricWidgetProps.getRegion()
setPeriodToTimeRange
(Boolean setPeriodToTimeRange) Sets the value ofGaugeWidgetProps.getSetPeriodToTimeRange()
Sets the value ofGaugeWidgetProps.getStart()
Sets the value ofGaugeWidgetProps.getStatistic()
Sets the value ofMetricWidgetProps.getTitle()
Sets the value ofMetricWidgetProps.getWidth()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
annotations
@Stability(Stable) public GaugeWidgetProps.Builder annotations(List<? extends HorizontalAnnotation> annotations) Sets the value ofGaugeWidgetProps.getAnnotations()
- Parameters:
annotations
- Annotations for the left Y axis.- Returns:
this
-
end
Sets the value ofGaugeWidgetProps.getEnd()
- Parameters:
end
- The end of the time range to use for each widget independently from those of the dashboard. 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
-
leftYAxis
Sets the value ofGaugeWidgetProps.getLeftYAxis()
- Parameters:
leftYAxis
- Left Y axis.- Returns:
this
-
legendPosition
Sets the value ofGaugeWidgetProps.getLegendPosition()
- Parameters:
legendPosition
- Position of the legend.- Returns:
this
-
liveData
Sets the value ofGaugeWidgetProps.getLiveData()
- Parameters:
liveData
- Whether the graph should show live data.- Returns:
this
-
metrics
Sets the value ofGaugeWidgetProps.getMetrics()
- Parameters:
metrics
- Metrics to display on left Y axis.- Returns:
this
-
period
Sets the value ofGaugeWidgetProps.getPeriod()
- Parameters:
period
- 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.- Returns:
this
-
setPeriodToTimeRange
@Stability(Stable) public GaugeWidgetProps.Builder setPeriodToTimeRange(Boolean setPeriodToTimeRange) Sets the value ofGaugeWidgetProps.getSetPeriodToTimeRange()
- Parameters:
setPeriodToTimeRange
- 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.- Returns:
this
-
start
Sets the value ofGaugeWidgetProps.getStart()
- Parameters:
start
- The start of the time range to use for each widget independently from those of 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
-
statistic
Sets the value ofGaugeWidgetProps.getStatistic()
- Parameters:
statistic
- The default statistic to be displayed for each metric. This default can be overridden within the definition of each individual metric- Returns:
this
-
height
Sets the value ofMetricWidgetProps.getHeight()
- Parameters:
height
- Height of the widget.- Returns:
this
-
region
Sets the value ofMetricWidgetProps.getRegion()
- Parameters:
region
- The region the metrics of this graph should be taken from.- Returns:
this
-
title
Sets the value ofMetricWidgetProps.getTitle()
- Parameters:
title
- Title for the graph.- Returns:
this
-
width
Sets the value ofMetricWidgetProps.getWidth()
- Parameters:
width
- Width of the widget, in a grid of 24 units wide.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<GaugeWidgetProps>
- Returns:
- a new instance of
GaugeWidgetProps
- Throws:
NullPointerException
- if any required attribute was not provided
-