AlarmWidgetProps

class aws_cdk.aws_cloudwatch.AlarmWidgetProps(*, account_id=None, height=None, region=None, title=None, width=None, alarm, left_y_axis=None)

Bases: MetricWidgetProps

Properties for an AlarmWidget.

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

  • alarm (IAlarm) – The alarm to show.

  • left_y_axis (Union[YAxisProps, Dict[str, Any], None]) – Left Y axis. Default: - No minimum or maximum values for the left Y-axis

ExampleMetadata:

infused

Example:

# dashboard: cloudwatch.Dashboard
# error_alarm: cloudwatch.Alarm


dashboard.add_widgets(cloudwatch.AlarmWidget(
    title="Errors",
    alarm=error_alarm
))

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

alarm

The alarm to show.

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.

left_y_axis

Left Y axis.

Default:

  • No minimum or maximum values for the left Y-axis

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