Package software.amazon.awscdk.services.cloudwatch

Interface YAxisProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

YAxisProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:26.931Z")
@Stability(Stable)
public interface YAxisProps
extends software.amazon.jsii.JsiiSerializable

Properties for a Y-Axis.

Example:

 Dashboard dashboard;
 Alarm errorAlarm;
 Metric gaugeMetric;
 dashboard.addWidgets(GaugeWidget.Builder.create()
         .metrics(List.of(gaugeMetric))
         .leftYAxis(YAxisProps.builder()
                 .min(0)
                 .max(1000)
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static YAxisProps.Builder	builder()
default String	getLabel()	The label.
default Number	getMax()	The max value.
default Number	getMin()	The min value.
default Boolean	getShowUnits()	Whether to show units.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLabel

@Stability(Stable)
@Nullable
default String getLabel()

The label.

Default: - No label

getMax

@Stability(Stable)
@Nullable
default Number getMax()

The max value.

Default: - No maximum value

getMin

@Stability(Stable)
@Nullable
default Number getMin()

The min value.

Default: 0

getShowUnits

@Stability(Stable)
@Nullable
default Boolean getShowUnits()

Whether to show units.

Default: true

builder

@Stability(Stable)
static YAxisProps.Builder builder()

Returns:

a YAxisProps.Builder of YAxisProps