CfnAlarmProps

class aws_cdk.aws_cloudwatch.CfnAlarmProps(*, comparison_operator, evaluation_periods, actions_enabled=None, alarm_actions=None, alarm_description=None, alarm_name=None, datapoints_to_alarm=None, dimensions=None, evaluate_low_sample_count_percentile=None, extended_statistic=None, insufficient_data_actions=None, metric_name=None, metrics=None, namespace=None, ok_actions=None, period=None, statistic=None, threshold=None, threshold_metric_id=None, treat_missing_data=None, unit=None)

Bases: object

__init__(*, comparison_operator, evaluation_periods, actions_enabled=None, alarm_actions=None, alarm_description=None, alarm_name=None, datapoints_to_alarm=None, dimensions=None, evaluate_low_sample_count_percentile=None, extended_statistic=None, insufficient_data_actions=None, metric_name=None, metrics=None, namespace=None, ok_actions=None, period=None, statistic=None, threshold=None, threshold_metric_id=None, treat_missing_data=None, unit=None)

Properties for defining a AWS::CloudWatch::Alarm.

Parameters
  • comparison_operator (str) – AWS::CloudWatch::Alarm.ComparisonOperator.

  • evaluation_periods (Union[int, float]) – AWS::CloudWatch::Alarm.EvaluationPeriods.

  • actions_enabled (Union[bool, None, IResolvable]) – AWS::CloudWatch::Alarm.ActionsEnabled.

  • alarm_actions (Optional[List[str]]) – AWS::CloudWatch::Alarm.AlarmActions.

  • alarm_description (Optional[str]) – AWS::CloudWatch::Alarm.AlarmDescription.

  • alarm_name (Optional[str]) – AWS::CloudWatch::Alarm.AlarmName.

  • datapoints_to_alarm (Union[int, float, None]) – AWS::CloudWatch::Alarm.DatapointsToAlarm.

  • dimensions (Union[IResolvable, None, List[Union[IResolvable, DimensionProperty]]]) – AWS::CloudWatch::Alarm.Dimensions.

  • evaluate_low_sample_count_percentile (Optional[str]) – AWS::CloudWatch::Alarm.EvaluateLowSampleCountPercentile.

  • extended_statistic (Optional[str]) – AWS::CloudWatch::Alarm.ExtendedStatistic.

  • insufficient_data_actions (Optional[List[str]]) – AWS::CloudWatch::Alarm.InsufficientDataActions.

  • metric_name (Optional[str]) – AWS::CloudWatch::Alarm.MetricName.

  • metrics (Union[IResolvable, None, List[Union[IResolvable, MetricDataQueryProperty]]]) – AWS::CloudWatch::Alarm.Metrics.

  • namespace (Optional[str]) – AWS::CloudWatch::Alarm.Namespace.

  • ok_actions (Optional[List[str]]) – AWS::CloudWatch::Alarm.OKActions.

  • period (Union[int, float, None]) – AWS::CloudWatch::Alarm.Period.

  • statistic (Optional[str]) – AWS::CloudWatch::Alarm.Statistic.

  • threshold (Union[int, float, None]) – AWS::CloudWatch::Alarm.Threshold.

  • threshold_metric_id (Optional[str]) – AWS::CloudWatch::Alarm.ThresholdMetricId.

  • treat_missing_data (Optional[str]) – AWS::CloudWatch::Alarm.TreatMissingData.

  • unit (Optional[str]) – AWS::CloudWatch::Alarm.Unit.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html

Attributes

actions_enabled

AWS::CloudWatch::Alarm.ActionsEnabled.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-actionsenabled

Return type

Union[bool, None, IResolvable]

alarm_actions

AWS::CloudWatch::Alarm.AlarmActions.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmactions

Return type

Optional[List[str]]

alarm_description

AWS::CloudWatch::Alarm.AlarmDescription.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmdescription

Return type

Optional[str]

alarm_name

AWS::CloudWatch::Alarm.AlarmName.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmname

Return type

Optional[str]

comparison_operator

AWS::CloudWatch::Alarm.ComparisonOperator.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-comparisonoperator

Return type

str

datapoints_to_alarm

AWS::CloudWatch::Alarm.DatapointsToAlarm.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-datapointstoalarm

Return type

Union[int, float, None]

dimensions

AWS::CloudWatch::Alarm.Dimensions.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dimension

Return type

Union[IResolvable, None, List[Union[IResolvable, DimensionProperty]]]

evaluate_low_sample_count_percentile

AWS::CloudWatch::Alarm.EvaluateLowSampleCountPercentile.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile

Return type

Optional[str]

evaluation_periods

AWS::CloudWatch::Alarm.EvaluationPeriods.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluationperiods

Return type

Union[int, float]

extended_statistic

AWS::CloudWatch::Alarm.ExtendedStatistic.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-extendedstatistic

Return type

Optional[str]

insufficient_data_actions

AWS::CloudWatch::Alarm.InsufficientDataActions.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-insufficientdataactions

Return type

Optional[List[str]]

metric_name

AWS::CloudWatch::Alarm.MetricName.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-metricname

Return type

Optional[str]

metrics

AWS::CloudWatch::Alarm.Metrics.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-metrics

Return type

Union[IResolvable, None, List[Union[IResolvable, MetricDataQueryProperty]]]

namespace

AWS::CloudWatch::Alarm.Namespace.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-namespace

Return type

Optional[str]

ok_actions

AWS::CloudWatch::Alarm.OKActions.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-okactions

Return type

Optional[List[str]]

period

AWS::CloudWatch::Alarm.Period.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-period

Return type

Union[int, float, None]

statistic

AWS::CloudWatch::Alarm.Statistic.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-statistic

Return type

Optional[str]

threshold

AWS::CloudWatch::Alarm.Threshold.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-threshold

Return type

Union[int, float, None]

threshold_metric_id

AWS::CloudWatch::Alarm.ThresholdMetricId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dynamic-threshold

Return type

Optional[str]

treat_missing_data

AWS::CloudWatch::Alarm.TreatMissingData.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-treatmissingdata

Return type

Optional[str]

unit

AWS::CloudWatch::Alarm.Unit.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-unit

Return type

Optional[str]