MetricRenderingProperties

class aws_cdk.aws_cloudwatch.MetricRenderingProperties(*, color=None, label=None, period, stat=None)

Bases: object

(deprecated) Custom rendering properties that override the default rendering properties specified in the yAxis parameter of the widget object.

Parameters
  • color (Optional[str]) – (deprecated) The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here.

  • label (Optional[str]) – (deprecated) Label for the metric.

  • period (Union[int, float]) – (deprecated) How many seconds to aggregate over.

  • stat (Optional[str]) – (deprecated) Aggregation function to use (can be either simple or a percentile).

Deprecated

Replaced by MetricConfig.

Stability

deprecated

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_rendering_properties = cloudwatch.MetricRenderingProperties(
    period=123,

    # the properties below are optional
    color="color",
    label="label",
    stat="stat"
)

Attributes

color

(deprecated) The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here.

Stability

deprecated

Return type

Optional[str]

label

(deprecated) Label for the metric.

Stability

deprecated

Return type

Optional[str]

period

(deprecated) How many seconds to aggregate over.

Stability

deprecated

Return type

Union[int, float]

stat

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

Stability

deprecated

Return type

Optional[str]