GraphWidgetProps¶
-
class
aws_cdk.aws_cloudwatch.
GraphWidgetProps
(*, height=None, region=None, title=None, width=None, left=None, left_annotations=None, left_y_axis=None, legend_position=None, live_data=None, period=None, right=None, right_annotations=None, right_y_axis=None, set_period_to_time_range=None, stacked=None, statistic=None, view=None)¶ Bases:
aws_cdk.aws_cloudwatch.MetricWidgetProps
Properties for a GraphWidget.
- Parameters
height (
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: 6left (
Optional
[Sequence
[IMetric
]]) – Metrics to display on left Y axis. Default: - No metricsleft_annotations (
Optional
[Sequence
[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: falseperiod (
Optional
[Duration
]) – 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)right (
Optional
[Sequence
[IMetric
]]) – Metrics to display on right Y axis. Default: - No metricsright_annotations (
Optional
[Sequence
[HorizontalAnnotation
]]) – Annotations for the right Y axis. Default: - No annotationsright_y_axis (
Optional
[YAxisProps
]) – Right Y axis. Default: - Noneset_period_to_time_range (
Optional
[bool
]) – 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: falsestacked (
Optional
[bool
]) – Whether the graph should be shown as stacked lines. Default: falsestatistic (
Optional
[str
]) – 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 usedview (
Optional
[GraphWidgetView
]) – Display this metric. Default: TimeSeries
- ExampleMetadata
infused
Example:
# dashboard: cloudwatch.Dashboard dashboard.add_widgets(cloudwatch.GraphWidget( # ... legend_position=cloudwatch.LegendPosition.RIGHT ))
Attributes
-
height
¶ 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.
- Return type
Union
[int
,float
,None
]
-
left_annotations
¶ Annotations for the left Y axis.
- Default
No annotations
- Return type
Optional
[List
[HorizontalAnnotation
]]
-
left_y_axis
¶ Left Y axis.
- Default
None
- Return type
Optional
[YAxisProps
]
-
legend_position
¶ Position of the legend.
- Default
bottom
- Return type
Optional
[LegendPosition
]
-
live_data
¶ Whether the graph should show live data.
- Default
false
- Return type
Optional
[bool
]
-
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.
- Default
cdk.Duration.seconds(300)
- Return type
Optional
[Duration
]
-
region
¶ The region the metrics of this graph should be taken from.
- Default
Current region
- Return type
Optional
[str
]
-
right_annotations
¶ Annotations for the right Y axis.
- Default
No annotations
- Return type
Optional
[List
[HorizontalAnnotation
]]
-
right_y_axis
¶ Right Y axis.
- Default
None
- Return type
Optional
[YAxisProps
]
-
set_period_to_time_range
¶ 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
- Return type
Optional
[bool
]
-
stacked
¶ Whether the graph should be shown as stacked lines.
- Default
false
- Return type
Optional
[bool
]
-
statistic
¶ 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
- Return type
Optional
[str
]
-
title
¶ Title for the graph.
- Default
None
- Return type
Optional
[str
]
-
view
¶ Display this metric.
- Default
TimeSeries
- Return type
Optional
[GraphWidgetView
]
-
width
¶ Width of the widget, in a grid of 24 units wide.
- Default
6
- Return type
Union
[int
,float
,None
]