RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/Lightsail/Types/Alarm.html below:

Alarm — AWS SDK for Ruby V2

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Lightsail::Types::Alarm

Inherits:

Struct

Object
Struct
Aws::Lightsail::Types::Alarm

show all

Defined in:: (unknown)

Overview

Describes an alarm.

An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.

Instance Attribute Summary collapse

#arn ⇒ String The Amazon Resource Name (ARN) of the alarm.
#comparison_operator ⇒ String The arithmetic operation used when comparing the specified statistic and threshold.
#contact_protocols ⇒ Array<String> The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
#created_at ⇒ Time The timestamp when the alarm was created.
#datapoints_to_alarm ⇒ Integer The number of data points that must not within the specified threshold to trigger the alarm.
#evaluation_periods ⇒ Integer The number of periods over which data is compared to the specified threshold.
#location ⇒ Types::ResourceLocation An object that lists information about the location of the alarm.
#metric_name ⇒ String The name of the metric associated with the alarm.
#monitored_resource_info ⇒ Types::MonitoredResourceInfo An object that lists information about the resource monitored by the alarm.
#name ⇒ String The name of the alarm.
#notification_enabled ⇒ Boolean Indicates whether the alarm is enabled.
#notification_triggers ⇒ Array<String> The alarm states that trigger a notification.
#period ⇒ Integer The period, in seconds, over which the statistic is applied.
#resource_type ⇒ String The Lightsail resource type (e.g., Alarm).
#state ⇒ String The current state of the alarm.
#statistic ⇒ String The statistic for the metric associated with the alarm.
#support_code ⇒ String The support code.
#threshold ⇒ Float The value against which the specified statistic is compared.
#treat_missing_data ⇒ String Specifies how the alarm handles missing data points.
#unit ⇒ String The unit of the metric associated with the alarm.

Instance Attribute Details #arn ⇒ String

The Amazon Resource Name (ARN) of the alarm.

#comparison_operator ⇒ String

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

Possible values:

GreaterThanOrEqualToThreshold
GreaterThanThreshold
LessThanThreshold
LessThanOrEqualToThreshold

#contact_protocols ⇒ Array<String>

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

#created_at ⇒ Time

The timestamp when the alarm was created.

#datapoints_to_alarm ⇒ Integer

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

#evaluation_periods ⇒ Integer

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

#metric_name ⇒ String

The name of the metric associated with the alarm.

Possible values:

CPUUtilization
NetworkIn
NetworkOut
StatusCheckFailed
StatusCheckFailed_Instance
StatusCheckFailed_System
ClientTLSNegotiationErrorCount
HealthyHostCount
UnhealthyHostCount
HTTPCode_LB_4XX_Count
HTTPCode_LB_5XX_Count
HTTPCode_Instance_2XX_Count
HTTPCode_Instance_3XX_Count
HTTPCode_Instance_4XX_Count
HTTPCode_Instance_5XX_Count
InstanceResponseTime
RejectedConnectionCount
RequestCount
DatabaseConnections
DiskQueueDepth
FreeStorageSpace
NetworkReceiveThroughput
NetworkTransmitThroughput
BurstCapacityTime
BurstCapacityPercentage

#notification_enabled ⇒ Boolean

Indicates whether the alarm is enabled.

#notification_triggers ⇒ Array<String>

The alarm states that trigger a notification.

#period ⇒ Integer

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

#resource_type ⇒ String

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

Possible values:

ContainerService
Instance
StaticIp
KeyPair
InstanceSnapshot
Domain
PeeredVpc
LoadBalancer
LoadBalancerTlsCertificate
Disk
DiskSnapshot
RelationalDatabase
RelationalDatabaseSnapshot
ExportSnapshotRecord
CloudFormationStackRecord
Alarm
ContactMethod
Distribution
Certificate

#state ⇒ String

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.

Possible values:
- OK
- ALARM
- INSUFFICIENT_DATA

#statistic ⇒ String

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.

Possible values:
- Minimum
- Maximum
- Sum
- Average
- SampleCount

#support_code ⇒ String

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.

#threshold ⇒ Float

The value against which the specified statistic is compared.

#treat_missing_data ⇒ String

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.

Possible values:
- breaching
- notBreaching
- ignore
- missing

#unit ⇒ String

The unit of the metric associated with the alarm.

Possible values:

Seconds
Microseconds
Milliseconds
Bytes
Kilobytes
Megabytes
Gigabytes
Terabytes
Bits
Kilobits
Megabits
Gigabits
Terabits
Percent
Count
Bytes/Second
Kilobytes/Second
Megabytes/Second
Gigabytes/Second
Terabytes/Second
Bits/Second
Kilobits/Second
Megabits/Second
Gigabits/Second
Terabits/Second
Count/Second
None

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4