MetricAlarm

public struct MetricAlarm : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let actionsEnabled: Bool?

  • 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

    Swift

    public let alarmActions: [String]?

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

    Declaration

    Swift

    public let alarmArn: String?

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

    Declaration

    Swift

    public let alarmConfigurationUpdatedTimestamp: TimeStamp?

  • The description of the alarm.

    Declaration

    Swift

    public let alarmDescription: String?

  • The name of the alarm.

    Declaration

    Swift

    public let alarmName: String?

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

    Declaration

    Swift

    public let comparisonOperator: ComparisonOperator?

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

    Declaration

    Swift

    public let datapointsToAlarm: Int?

  • The dimensions for the metric associated with the alarm.

    Declaration

    Swift

    public let dimensions: [Dimension]?

  • 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

    Swift

    public let evaluateLowSampleCountPercentile: String?

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

    Declaration

    Swift

    public let evaluationPeriods: Int?

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

    Declaration

    Swift

    public let extendedStatistic: String?

  • 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

    Swift

    public let insufficientDataActions: [String]?

  • The name of the metric associated with the alarm, if this is an alarm based on a single metric.

    Declaration

    Swift

    public let metricName: String?

  • An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnValue set to true.

    Declaration

    Swift

    public let metrics: [MetricDataQuery]?

  • The namespace of the metric associated with the alarm.

    Declaration

    Swift

    public let namespace: String?

  • 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

    Swift

    public let oKActions: [String]?

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

    Declaration

    Swift

    public let period: Int?

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

    Declaration

    Swift

    public let stateReason: String?

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

    Declaration

    Swift

    public let stateReasonData: String?

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

    Declaration

    Swift

    public let stateUpdatedTimestamp: TimeStamp?

  • The state value for the alarm.

    Declaration

    Swift

    public let stateValue: StateValue?

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

    Declaration

    Swift

    public let statistic: Statistic?

  • The value to compare with the specified statistic.

    Declaration

    Swift

    public let threshold: Double?

  • In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

    Declaration

    Swift

    public let thresholdMetricId: String?

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

    Declaration

    Swift

    public let treatMissingData: String?

  • The unit of the metric associated with the alarm.

    Declaration

    Swift

    public let unit: StandardUnit?

  • Undocumented

    Declaration

    Swift

    public init(actionsEnabled: Bool? = nil, alarmActions: [String]? = nil, alarmArn: String? = nil, alarmConfigurationUpdatedTimestamp: TimeStamp? = nil, alarmDescription: String? = nil, alarmName: String? = nil, comparisonOperator: ComparisonOperator? = nil, datapointsToAlarm: Int? = nil, dimensions: [Dimension]? = nil, evaluateLowSampleCountPercentile: String? = nil, evaluationPeriods: Int? = nil, extendedStatistic: String? = nil, insufficientDataActions: [String]? = nil, metricName: String? = nil, metrics: [MetricDataQuery]? = nil, namespace: String? = nil, oKActions: [String]? = nil, period: Int? = nil, stateReason: String? = nil, stateReasonData: String? = nil, stateUpdatedTimestamp: TimeStamp? = nil, stateValue: StateValue? = nil, statistic: Statistic? = nil, threshold: Double? = nil, thresholdMetricId: String? = nil, treatMissingData: String? = nil, unit: StandardUnit? = nil)