Alarm

public struct Alarm : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • arn

    The Amazon Resource Name (ARN) of the alarm.

    Declaration

    Swift

    public let arn: String?

  • The arithmetic operation used when comparing the specified statistic and threshold.

    Declaration

    Swift

    public let comparisonOperator: ComparisonOperator?

  • The contact protocols for the alarm, such as Email, SMS (text messaging), or both.

    Declaration

    Swift

    public let contactProtocols: [ContactProtocol]?

  • The timestamp when the alarm was created.

    Declaration

    Swift

    public let createdAt: TimeStamp?

  • The number of data points that must not within the specified threshold to trigger the alarm.

    Declaration

    Swift

    public let datapointsToAlarm: Int?

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

    Declaration

    Swift

    public let evaluationPeriods: Int?

  • An object that lists information about the location of the alarm.

    Declaration

    Swift

    public let location: ResourceLocation?

  • The name of the metric associated with the alarm.

    Declaration

    Swift

    public let metricName: MetricName?

  • An object that lists information about the resource monitored by the alarm.

    Declaration

    Swift

    public let monitoredResourceInfo: MonitoredResourceInfo?

  • The name of the alarm.

    Declaration

    Swift

    public let name: String?

  • Indicates whether the alarm is enabled.

    Declaration

    Swift

    public let notificationEnabled: Bool?

  • The alarm states that trigger a notification.

    Declaration

    Swift

    public let notificationTriggers: [AlarmState]?

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

    Declaration

    Swift

    public let period: Int?

  • The Lightsail resource type (e.g., Alarm).

    Declaration

    Swift

    public let resourceType: ResourceType?

  • The current state of the alarm. An alarm has the following possible states: ALARM - The metric is outside of the defined threshold. INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. OK - The metric is within the defined threshold.

    Declaration

    Swift

    public let state: AlarmState?

  • The statistic for the metric associated with the alarm. The following statistics are available: Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. SampleCount - The count, or number, of data points used for the statistical calculation.

    Declaration

    Swift

    public let statistic: MetricStatistic?

  • The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

    Declaration

    Swift

    public let supportCode: String?

  • The value against which the specified statistic is compared.

    Declaration

    Swift

    public let threshold: Double?

  • Specifies how the alarm handles missing data points. An alarm can treat missing data in the following ways: breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold. notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold. ignore - Ignore the missing data. Maintains the current alarm state. missing - Missing data is treated as missing.

    Declaration

    Swift

    public let treatMissingData: TreatMissingData?

  • The unit of the metric associated with the alarm.

    Declaration

    Swift

    public let unit: MetricUnit?

  • Undocumented

    Declaration

    Swift

    public init(arn: String? = nil, comparisonOperator: ComparisonOperator? = nil, contactProtocols: [ContactProtocol]? = nil, createdAt: TimeStamp? = nil, datapointsToAlarm: Int? = nil, evaluationPeriods: Int? = nil, location: ResourceLocation? = nil, metricName: MetricName? = nil, monitoredResourceInfo: MonitoredResourceInfo? = nil, name: String? = nil, notificationEnabled: Bool? = nil, notificationTriggers: [AlarmState]? = nil, period: Int? = nil, resourceType: ResourceType? = nil, state: AlarmState? = nil, statistic: MetricStatistic? = nil, supportCode: String? = nil, threshold: Double? = nil, treatMissingData: TreatMissingData? = nil, unit: MetricUnit? = nil)