MetricWidgetProps

class aws_cdk.aws_cloudwatch.MetricWidgetProps(*, height=None, region=None, title=None, width=None)

Bases: object

Basic properties for widgets that display metrics.

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 region

  • title (Optional[str]) – Title for the graph. Default: - None

  • width (Union[int, float, None]) – Width of the widget, in a grid of 24 units wide. Default: 6

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cloudwatch as cloudwatch

metric_widget_props = cloudwatch.MetricWidgetProps(
    height=123,
    region="region",
    title="title",
    width=123
)

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]

region

The region the metrics of this graph should be taken from.

Default
  • Current region

Return type

Optional[str]

title

Title for the graph.

Default
  • None

Return type

Optional[str]

width

Width of the widget, in a grid of 24 units wide.

Default

6

Return type

Union[int, float, None]