AWSCloudWatchMetricAlarm

Objective-C

@interface AWSCloudWatchMetricAlarm

Swift

class AWSCloudWatchMetricAlarm

Represents an alarm.

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable actionsEnabled;

    Swift

    var actionsEnabled: NSNumber? { get set }

  • 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).

    Declaration

    Objective-C

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

    Swift

    var alarmActions: [String]? { get set }

  • The Amazon Resource Name (ARN) of the alarm.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable alarmArn;

    Swift

    var alarmArn: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable alarmConfigurationUpdatedTimestamp;

    Swift

    var alarmConfigurationUpdatedTimestamp: Date? { get set }

  • The description of the alarm.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable alarmDescription;

    Swift

    var alarmDescription: String? { get set }

  • The name of the alarm.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable alarmName;

    Swift

    var alarmName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSCloudWatchComparisonOperator comparisonOperator;

    Swift

    var comparisonOperator: AWSCloudWatchComparisonOperator { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable datapointsToAlarm;

    Swift

    var datapointsToAlarm: NSNumber? { get set }

  • The dimensions for the metric associated with the alarm.

    Declaration

    Objective-C

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

    Swift

    var dimensions: [AWSCloudWatchDimension]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable evaluateLowSampleCountPercentile;

    Swift

    var evaluateLowSampleCountPercentile: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable evaluationPeriods;

    Swift

    var evaluationPeriods: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable extendedStatistic;

    Swift

    var extendedStatistic: String? { get set }

  • 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).

    Declaration

    Objective-C

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

    Swift

    var insufficientDataActions: [String]? { get set }

  • The name of the metric associated with the alarm.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable metricName;

    Swift

    var metricName: String? { get set }

  • Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSCloudWatchMetricDataQuery *> *_Nullable metrics;

    Swift

    var metrics: [AWSCloudWatchMetricDataQuery]? { get set }

  • The namespace of the metric associated with the alarm.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable namespace;

    Swift

    var namespace: String? { get set }

  • 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).

    Declaration

    Objective-C

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

    Swift

    var okActions: [String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable period;

    Swift

    var period: NSNumber? { get set }

  • An explanation for the alarm state, in text format.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable stateReason;

    Swift

    var stateReason: String? { get set }

  • An explanation for the alarm state, in JSON format.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable stateReasonData;

    Swift

    var stateReasonData: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable stateUpdatedTimestamp;

    Swift

    var stateUpdatedTimestamp: Date? { get set }

  • The state value for the alarm.

    Declaration

    Objective-C

    @property (nonatomic) AWSCloudWatchStateValue stateValue;

    Swift

    var stateValue: AWSCloudWatchStateValue { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSCloudWatchStatistic statistic;

    Swift

    var statistic: AWSCloudWatchStatistic { get set }

  • The value to compare with the specified statistic.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable threshold;

    Swift

    var threshold: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable treatMissingData;

    Swift

    var treatMissingData: String? { get set }

  • The unit of the metric associated with the alarm.

    Declaration

    Objective-C

    @property (nonatomic) AWSCloudWatchStandardUnit unit;

    Swift

    var unit: AWSCloudWatchStandardUnit { get set }