Struct rusoto_lightsail::PutAlarmRequest
source · [−]pub struct PutAlarmRequest {
pub alarm_name: String,
pub comparison_operator: String,
pub contact_protocols: Option<Vec<String>>,
pub datapoints_to_alarm: Option<i64>,
pub evaluation_periods: i64,
pub metric_name: String,
pub monitored_resource_name: String,
pub notification_enabled: Option<bool>,
pub notification_triggers: Option<Vec<String>>,
pub threshold: f64,
pub treat_missing_data: Option<String>,
}
Fields
alarm_name: String
The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
comparison_operator: String
The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
contact_protocols: Option<Vec<String>>
The contact protocols to use for the alarm, such as Email
, SMS
(text messaging), or both.
A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.
A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the notificationEnabled
paramater.
Use the CreateContactMethod
action to configure a contact protocol in an AWS Region.
datapoints_to_alarm: Option<i64>
The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm
) is the M.
evaluation_periods: i64
The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods
) is the N.
If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated.
Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours.
You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).
metric_name: String
The name of the metric to associate with the alarm.
You can configure up to two alarms per metric.
The following metrics are available for each resource type:
-
Instances:
BurstCapacityPercentage
,BurstCapacityTime
,CPUUtilization
,NetworkIn
,NetworkOut
,StatusCheckFailed
,StatusCheckFailed_Instance
, andStatusCheckFailed_System
. -
Load balancers:
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
, andRequestCount
. -
Relational databases:
CPUUtilization
,DatabaseConnections
,DiskQueueDepth
,FreeStorageSpace
,NetworkReceiveThroughput
, andNetworkTransmitThroughput
.
For more information about these metrics, see Metrics available in Lightsail.
monitored_resource_name: String
The name of the Lightsail resource that will be monitored.
Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.
notification_enabled: Option<bool>
Indicates whether the alarm is enabled.
Notifications are enabled by default if you don't specify this parameter.
notification_triggers: Option<Vec<String>>
The alarm states that trigger a notification.
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.
When you specify a notification trigger, the ALARM
state must be specified. The INSUFFICIENT_DATA
and OK
states can be specified in addition to the ALARM
state.
-
If you specify
OK
as an alarm trigger, a notification is sent when the alarm switches from anALARM
orINSUFFICIENT_DATA
alarm state to anOK
state. This can be thought of as an all clear alarm notification. -
If you specify
INSUFFICIENT_DATA
as the alarm trigger, a notification is sent when the alarm switches from anOK
orALARM
alarm state to anINSUFFICIENT_DATA
state.
The notification trigger defaults to ALARM
if you don't specify this parameter.
threshold: f64
The value against which the specified statistic is compared.
treat_missing_data: Option<String>
Sets how this alarm will handle 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.
If treatMissingData
is not specified, the default behavior of missing
is used.
Trait Implementations
sourceimpl Clone for PutAlarmRequest
impl Clone for PutAlarmRequest
sourcefn clone(&self) -> PutAlarmRequest
fn clone(&self) -> PutAlarmRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for PutAlarmRequest
impl Debug for PutAlarmRequest
sourceimpl Default for PutAlarmRequest
impl Default for PutAlarmRequest
sourcefn default() -> PutAlarmRequest
fn default() -> PutAlarmRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<PutAlarmRequest> for PutAlarmRequest
impl PartialEq<PutAlarmRequest> for PutAlarmRequest
sourcefn eq(&self, other: &PutAlarmRequest) -> bool
fn eq(&self, other: &PutAlarmRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &PutAlarmRequest) -> bool
fn ne(&self, other: &PutAlarmRequest) -> bool
This method tests for !=
.
sourceimpl Serialize for PutAlarmRequest
impl Serialize for PutAlarmRequest
impl StructuralPartialEq for PutAlarmRequest
Auto Trait Implementations
impl RefUnwindSafe for PutAlarmRequest
impl Send for PutAlarmRequest
impl Sync for PutAlarmRequest
impl Unpin for PutAlarmRequest
impl UnwindSafe for PutAlarmRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more