AWSCloudWatchMetricAlarm Class Reference

Inherits from AWSModel : AWSMTLModel
Declared in AWSCloudWatchModel.h
AWSCloudWatchModel.m

Overview

Represents an alarm.

  actionsEnabled

Indicates whether actions should be executed during any changes to the alarm state.

@property (nonatomic, strong) NSNumber *actionsEnabled

Declared In

AWSCloudWatchModel.h

  alarmActions

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

@property (nonatomic, strong) NSArray<NSString*> *alarmActions

Declared In

AWSCloudWatchModel.h

  alarmArn

The Amazon Resource Name (ARN) of the alarm.

@property (nonatomic, strong) NSString *alarmArn

Declared In

AWSCloudWatchModel.h

  alarmConfigurationUpdatedTimestamp

The time stamp of the last update to the alarm configuration.

@property (nonatomic, strong) NSDate *alarmConfigurationUpdatedTimestamp

Declared In

AWSCloudWatchModel.h

  alarmDescription

The description of the alarm.

@property (nonatomic, strong) NSString *alarmDescription

Declared In

AWSCloudWatchModel.h

  alarmName

The name of the alarm.

@property (nonatomic, strong) NSString *alarmName

Declared In

AWSCloudWatchModel.h

  comparisonOperator

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

@property (nonatomic, assign) AWSCloudWatchComparisonOperator comparisonOperator

Declared In

AWSCloudWatchModel.h

  datapointsToAlarm

The number of datapoints that must be breaching to trigger the alarm.

@property (nonatomic, strong) NSNumber *datapointsToAlarm

Declared In

AWSCloudWatchModel.h

  dimensions

The dimensions for the metric associated with the alarm.

@property (nonatomic, strong) NSArray<AWSCloudWatchDimension*> *dimensions

Declared In

AWSCloudWatchModel.h

  evaluateLowSampleCountPercentile

Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

@property (nonatomic, strong) NSString *evaluateLowSampleCountPercentile

Declared In

AWSCloudWatchModel.h

  evaluationPeriods

The number of periods over which data is compared to the specified threshold.

@property (nonatomic, strong) NSNumber *evaluationPeriods

Declared In

AWSCloudWatchModel.h

  extendedStatistic

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

@property (nonatomic, strong) NSString *extendedStatistic

Declared In

AWSCloudWatchModel.h

  insufficientDataActions

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

@property (nonatomic, strong) NSArray<NSString*> *insufficientDataActions

Declared In

AWSCloudWatchModel.h

  metricName

The name of the metric associated with the alarm.

@property (nonatomic, strong) NSString *metricName

Declared In

AWSCloudWatchModel.h

  namespace

The namespace of the metric associated with the alarm.

@property (nonatomic, strong) NSString *namespace

Declared In

AWSCloudWatchModel.h

  OKActions

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

@property (nonatomic, strong) NSArray<NSString*> *OKActions

Declared In

AWSCloudWatchModel.h

  period

The period, in seconds, over which the statistic is applied.

@property (nonatomic, strong) NSNumber *period

Declared In

AWSCloudWatchModel.h

  stateReason

An explanation for the alarm state, in text format.

@property (nonatomic, strong) NSString *stateReason

Declared In

AWSCloudWatchModel.h

  stateReasonData

An explanation for the alarm state, in JSON format.

@property (nonatomic, strong) NSString *stateReasonData

Declared In

AWSCloudWatchModel.h

  stateUpdatedTimestamp

The time stamp of the last update to the alarm state.

@property (nonatomic, strong) NSDate *stateUpdatedTimestamp

Declared In

AWSCloudWatchModel.h

  stateValue

The state value for the alarm.

@property (nonatomic, assign) AWSCloudWatchStateValue stateValue

Declared In

AWSCloudWatchModel.h

  statistic

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

@property (nonatomic, assign) AWSCloudWatchStatistic statistic

Declared In

AWSCloudWatchModel.h

  threshold

The value to compare with the specified statistic.

@property (nonatomic, strong) NSNumber *threshold

Declared In

AWSCloudWatchModel.h

  treatMissingData

Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.

@property (nonatomic, strong) NSString *treatMissingData

Declared In

AWSCloudWatchModel.h

  unit

The unit of the metric associated with the alarm.

@property (nonatomic, assign) AWSCloudWatchStandardUnit unit

Declared In

AWSCloudWatchModel.h