MetricAlarmConfig¶

class aws_cdk.aws_cloudwatch.MetricAlarmConfig(*, metric_name, namespace, period, dimensions=None, extended_statistic=None, statistic=None, unit=None)¶

Bases: object

(deprecated) Properties used to construct the Metric identifying part of an Alarm.

Parameters

metric_name (str) – (deprecated) Name of the metric.
namespace (str) – (deprecated) Namespace of the metric.
period (Union[int, float]) – (deprecated) How many seconds to aggregate over.
dimensions (Optional[Sequence[Dimension]]) – (deprecated) The dimensions to apply to the alarm.
extended_statistic (Optional[str]) – (deprecated) Percentile aggregation function to use.
statistic (Optional[Statistic]) – (deprecated) Simple aggregation function to use.
unit (Optional[Unit]) – (deprecated) The unit of the alarm.

Deprecated

Replaced by MetricConfig

Stability

deprecated

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

# value is of type object

metric_alarm_config = cloudwatch.MetricAlarmConfig(
    metric_name="metricName",
    namespace="namespace",
    period=123,

    # the properties below are optional
    dimensions=[cloudwatch.Dimension(
        name="name",
        value=value
    )],
    extended_statistic="extendedStatistic",
    statistic=cloudwatch.Statistic.SAMPLE_COUNT,
    unit=cloudwatch.Unit.SECONDS
)

Attributes

dimensions¶

(deprecated) The dimensions to apply to the alarm.

Stability: deprecated
Return type: Optional[List[Dimension]]

extended_statistic¶

(deprecated) Percentile aggregation function to use.

Stability: deprecated
Return type: Optional[str]

metric_name¶

(deprecated) Name of the metric.

Stability: deprecated
Return type: str

namespace¶

(deprecated) Namespace of the metric.

Stability: deprecated
Return type: str

period¶

(deprecated) How many seconds to aggregate over.

Stability: deprecated
Return type: Union[int, float]

statistic¶

(deprecated) Simple aggregation function to use.

Stability: deprecated
Return type: Optional[Statistic]

unit¶

(deprecated) The unit of the alarm.

Stability: deprecated
Return type: Optional[Unit]