GraphWidget¶
-
class
aws_cdk.aws_cloudwatch.
GraphWidget
(*, left=None, left_annotations=None, left_y_axis=None, legend_position=None, live_data=None, right=None, right_annotations=None, right_y_axis=None, stacked=None, view=None, height=None, region=None, title=None, width=None)¶ Bases:
aws_cdk.aws_cloudwatch.ConcreteWidget
A dashboard widget that displays metrics.
- Parameters
left (
Optional
[List
[IMetric
]]) – Metrics to display on left Y axis. Default: - No metricsleft_annotations (
Optional
[List
[HorizontalAnnotation
]]) – Annotations for the left Y axis. Default: - No annotationsleft_y_axis (
Optional
[YAxisProps
]) – Left Y axis. Default: - Nonelegend_position (
Optional
[LegendPosition
]) – Position of the legend. Default: - bottomlive_data (
Optional
[bool
]) – Whether the graph should show live data. Default: falseright (
Optional
[List
[IMetric
]]) – Metrics to display on right Y axis. Default: - No metricsright_annotations (
Optional
[List
[HorizontalAnnotation
]]) – Annotations for the right Y axis. Default: - No annotationsright_y_axis (
Optional
[YAxisProps
]) – Right Y axis. Default: - Nonestacked (
Optional
[bool
]) – Whether the graph should be shown as stacked lines. Default: falseview (
Optional
[GraphWidgetView
]) – Display this metric. Default: TimeSeriesheight (
Union
[int
,float
,None
]) – 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.region (
Optional
[str
]) – The region the metrics of this graph should be taken from. Default: - Current regiontitle (
Optional
[str
]) – Title for the graph. Default: - Nonewidth (
Union
[int
,float
,None
]) – Width of the widget, in a grid of 24 units wide. Default: 6
Methods
-
add_left_metric
(metric)¶ Add another metric to the left Y axis of the GraphWidget.
- Parameters
metric (
IMetric
) – the metric to add.- Return type
None
-
add_right_metric
(metric)¶ Add another metric to the right Y axis of the GraphWidget.
- Parameters
metric (
IMetric
) – the metric to add.- Return type
None
-
position
(x, y)¶ Place the widget at a given position.
- Parameters
x (
Union
[int
,float
]) –y (
Union
[int
,float
]) –
- Return type
None
-
to_json
()¶ Return the widget JSON for use in the dashboard.
- Return type
List
[Any
]
Attributes
-
height
¶ The amount of vertical grid units the widget will take up.
- Return type
Union
[int
,float
]
-
width
¶ The amount of horizontal grid units the widget will take up.
- Return type
Union
[int
,float
]