MetricWidgetProps

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

Bases: object

Basic properties for widgets that display metrics.

Parameters:

account_id (Optional[str]) – The AWS account ID where the metrics are located. This enables cross-account functionality for CloudWatch dashboards. Before using this feature, ensure that proper cross-account sharing is configured between the monitoring account and source account. For more information, see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html Default: - Current account
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.
from aws_cdk import aws_cloudwatch as cloudwatch

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

Attributes

account_id

The AWS account ID where the metrics are located.

This enables cross-account functionality for CloudWatch dashboards. Before using this feature, ensure that proper cross-account sharing is configured between the monitoring account and source account.

For more information, see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html

Default:

Current account

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.

region

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

Default:

Current region

title

Title for the graph.

Default:

None

width

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

Default:: 6