Skip to content

CloudWatchAlarmDefinition

Source code in docs_src/capo_emr/types/cloud_watch_alarm_definition.py
class CloudWatchAlarmDefinition(TypedDict, closed=True):
    comparison_operator: NotRequired[
        "capo_emr.types.comparison_operator.ComparisonOperator"
    ]
    """<p>Determines how the metric specified by <code>MetricName</code> is compared to the value specified by <code>Threshold</code>.</p>"""
    evaluation_periods: NotRequired["capo_emr.types.integer.Integer"]
    """<p>The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is <code>1</code>.</p>"""
    metric_name: NotRequired["capo_emr.types.string.String"]
    """<p>The name of the CloudWatch metric that is watched to determine an alarm condition.</p>"""
    namespace: NotRequired["capo_emr.types.string.String"]
    """<p>The namespace for the CloudWatch metric. The default is <code>AWS/ElasticMapReduce</code>.</p>"""
    period: NotRequired["capo_emr.types.integer.Integer"]
    """<p>The period, in seconds, over which the statistic is applied. CloudWatch metrics for Amazon EMR are emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify <code>300</code>.</p>"""
    statistic: NotRequired["capo_emr.types.statistic.Statistic"]
    """<p>The statistic to apply to the metric associated with the alarm. The default is <code>AVERAGE</code>.</p>"""
    threshold: NotRequired["capo_emr.types.non_negative_double.NonNegativeDouble"]
    """<p>The value against which the specified statistic is compared.</p>"""
    unit: NotRequired["capo_emr.types.unit.Unit"]
    """<p>The unit of measure associated with the CloudWatch metric being watched. The value specified for <code>Unit</code> must correspond to the units specified in the CloudWatch metric.</p>"""
    dimensions: NotRequired["capo_emr.types.metric_dimension_list.MetricDimensionList"]
    """<p>A CloudWatch metric dimension.</p>"""

comparison_operator instance-attribute

comparison_operator: NotRequired[ComparisonOperator]

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

dimensions instance-attribute

dimensions: NotRequired[MetricDimensionList]

A CloudWatch metric dimension.

evaluation_periods instance-attribute

evaluation_periods: NotRequired[Integer]

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

metric_name instance-attribute

metric_name: NotRequired[String]

The name of the CloudWatch metric that is watched to determine an alarm condition.

namespace instance-attribute

namespace: NotRequired[String]

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

period instance-attribute

period: NotRequired[Integer]

The period, in seconds, over which the statistic is applied. CloudWatch metrics for Amazon EMR are emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify 300.

statistic instance-attribute

statistic: NotRequired[Statistic]

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

threshold instance-attribute

threshold: NotRequired[NonNegativeDouble]

The value against which the specified statistic is compared.

unit instance-attribute

unit: NotRequired[Unit]

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.