MetricGraphConfig¶

class aws_cdk.aws_cloudwatch.MetricGraphConfig(*, metric_name, namespace, period, rendering_properties, color=None, dimensions=None, label=None, statistic=None, unit=None)¶

Bases: object

__init__(*, metric_name, namespace, period, rendering_properties, color=None, dimensions=None, label=None, statistic=None, unit=None)¶

Properties used to construct the Metric identifying part of a Graph.

Parameters

metric_name (str) – Name of the metric.
namespace (str) – Namespace of the metric.
period (Union[int, float]) – How many seconds to aggregate over.
rendering_properties (MetricRenderingProperties) – Rendering properties override yAxis parameter of the widget object.
color (Optional[str]) – Color for the graph line.
dimensions (Optional[List[Dimension]]) – The dimensions to apply to the alarm.
label (Optional[str]) – Label for the metric.
statistic (Optional[str]) – Aggregation function to use (can be either simple or a percentile).
unit (Optional[Unit]) – The unit of the alarm.

deprecated :deprecated: Replaced by MetricConfig

stability :stability: deprecated

Return type: None

Attributes

color¶

Color for the graph line.

deprecated :deprecated: Use color in renderingProperties

stability :stability: deprecated

Return type: Optional[str]

dimensions¶

The dimensions to apply to the alarm.

stability :stability: deprecated

Return type: Optional[List[Dimension]]

label¶

Label for the metric.

deprecated :deprecated: Use label in renderingProperties

stability :stability: deprecated

Return type: Optional[str]

metric_name¶

Name of the metric.

stability :stability: deprecated

Return type: str

namespace¶

Namespace of the metric.

stability :stability: deprecated

Return type: str

period¶

How many seconds to aggregate over.

deprecated :deprecated: Use period in renderingProperties

stability :stability: deprecated

Return type: Union[int, float]

rendering_properties¶

Rendering properties override yAxis parameter of the widget object.

stability :stability: deprecated

Return type: MetricRenderingProperties

statistic¶

Aggregation function to use (can be either simple or a percentile).

deprecated :deprecated: Use stat in renderingProperties

stability :stability: deprecated

Return type: Optional[str]

unit¶

The unit of the alarm.

deprecated :deprecated: not used in dashboard widgets

stability :stability: deprecated

Return type: Optional[Unit]