pub struct PutAlarmFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to PutAlarm
.
Creates or updates an alarm, and associates it with the specified metric.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA
. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.
Implementations§
source§impl PutAlarmFluentBuilder
impl PutAlarmFluentBuilder
sourcepub fn as_input(&self) -> &PutAlarmInputBuilder
pub fn as_input(&self) -> &PutAlarmInputBuilder
Access the PutAlarm as a reference.
sourcepub async fn send(
self
) -> Result<PutAlarmOutput, SdkError<PutAlarmError, HttpResponse>>
pub async fn send( self ) -> Result<PutAlarmOutput, SdkError<PutAlarmError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<PutAlarmOutput, PutAlarmError, Self>
pub fn customize( self ) -> CustomizableOperation<PutAlarmOutput, PutAlarmError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn alarm_name(self, input: impl Into<String>) -> Self
pub fn alarm_name(self, input: impl Into<String>) -> Self
The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
sourcepub fn set_alarm_name(self, input: Option<String>) -> Self
pub fn set_alarm_name(self, input: Option<String>) -> Self
The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
sourcepub fn get_alarm_name(&self) -> &Option<String>
pub fn get_alarm_name(&self) -> &Option<String>
The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
sourcepub fn metric_name(self, input: MetricName) -> Self
pub fn metric_name(self, input: MetricName) -> Self
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.
sourcepub fn set_metric_name(self, input: Option<MetricName>) -> Self
pub fn set_metric_name(self, input: Option<MetricName>) -> Self
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.
sourcepub fn get_metric_name(&self) -> &Option<MetricName>
pub fn get_metric_name(&self) -> &Option<MetricName>
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.
sourcepub fn monitored_resource_name(self, input: impl Into<String>) -> Self
pub fn monitored_resource_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_monitored_resource_name(self, input: Option<String>) -> Self
pub fn set_monitored_resource_name(self, input: Option<String>) -> Self
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.
sourcepub fn get_monitored_resource_name(&self) -> &Option<String>
pub fn get_monitored_resource_name(&self) -> &Option<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.
sourcepub fn comparison_operator(self, input: ComparisonOperator) -> Self
pub fn comparison_operator(self, input: ComparisonOperator) -> Self
The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
sourcepub fn set_comparison_operator(self, input: Option<ComparisonOperator>) -> Self
pub fn set_comparison_operator(self, input: Option<ComparisonOperator>) -> Self
The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
sourcepub fn get_comparison_operator(&self) -> &Option<ComparisonOperator>
pub fn get_comparison_operator(&self) -> &Option<ComparisonOperator>
The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
sourcepub fn threshold(self, input: f64) -> Self
pub fn threshold(self, input: f64) -> Self
The value against which the specified statistic is compared.
sourcepub fn set_threshold(self, input: Option<f64>) -> Self
pub fn set_threshold(self, input: Option<f64>) -> Self
The value against which the specified statistic is compared.
sourcepub fn get_threshold(&self) -> &Option<f64>
pub fn get_threshold(&self) -> &Option<f64>
The value against which the specified statistic is compared.
sourcepub fn evaluation_periods(self, input: i32) -> Self
pub fn evaluation_periods(self, input: i32) -> Self
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).
sourcepub fn set_evaluation_periods(self, input: Option<i32>) -> Self
pub fn set_evaluation_periods(self, input: Option<i32>) -> Self
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).
sourcepub fn get_evaluation_periods(&self) -> &Option<i32>
pub fn get_evaluation_periods(&self) -> &Option<i32>
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).
sourcepub fn datapoints_to_alarm(self, input: i32) -> Self
pub fn datapoints_to_alarm(self, input: i32) -> Self
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.
sourcepub fn set_datapoints_to_alarm(self, input: Option<i32>) -> Self
pub fn set_datapoints_to_alarm(self, input: Option<i32>) -> Self
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.
sourcepub fn get_datapoints_to_alarm(&self) -> &Option<i32>
pub fn get_datapoints_to_alarm(&self) -> &Option<i32>
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.
sourcepub fn treat_missing_data(self, input: TreatMissingData) -> Self
pub fn treat_missing_data(self, input: TreatMissingData) -> Self
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.
sourcepub fn set_treat_missing_data(self, input: Option<TreatMissingData>) -> Self
pub fn set_treat_missing_data(self, input: Option<TreatMissingData>) -> Self
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.
sourcepub fn get_treat_missing_data(&self) -> &Option<TreatMissingData>
pub fn get_treat_missing_data(&self) -> &Option<TreatMissingData>
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.
sourcepub fn contact_protocols(self, input: ContactProtocol) -> Self
pub fn contact_protocols(self, input: ContactProtocol) -> Self
Appends an item to contactProtocols
.
To override the contents of this collection use set_contact_protocols
.
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 Amazon Web Services 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 Amazon Web Services Region.
sourcepub fn set_contact_protocols(self, input: Option<Vec<ContactProtocol>>) -> Self
pub fn set_contact_protocols(self, input: Option<Vec<ContactProtocol>>) -> Self
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 Amazon Web Services 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 Amazon Web Services Region.
sourcepub fn get_contact_protocols(&self) -> &Option<Vec<ContactProtocol>>
pub fn get_contact_protocols(&self) -> &Option<Vec<ContactProtocol>>
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 Amazon Web Services 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 Amazon Web Services Region.
sourcepub fn notification_triggers(self, input: AlarmState) -> Self
pub fn notification_triggers(self, input: AlarmState) -> Self
Appends an item to notificationTriggers
.
To override the contents of this collection use set_notification_triggers
.
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.
sourcepub fn set_notification_triggers(self, input: Option<Vec<AlarmState>>) -> Self
pub fn set_notification_triggers(self, input: Option<Vec<AlarmState>>) -> Self
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.
sourcepub fn get_notification_triggers(&self) -> &Option<Vec<AlarmState>>
pub fn get_notification_triggers(&self) -> &Option<Vec<AlarmState>>
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.
sourcepub fn notification_enabled(self, input: bool) -> Self
pub fn notification_enabled(self, input: bool) -> Self
Indicates whether the alarm is enabled.
Notifications are enabled by default if you don't specify this parameter.
sourcepub fn set_notification_enabled(self, input: Option<bool>) -> Self
pub fn set_notification_enabled(self, input: Option<bool>) -> Self
Indicates whether the alarm is enabled.
Notifications are enabled by default if you don't specify this parameter.
sourcepub fn get_notification_enabled(&self) -> &Option<bool>
pub fn get_notification_enabled(&self) -> &Option<bool>
Indicates whether the alarm is enabled.
Notifications are enabled by default if you don't specify this parameter.
Trait Implementations§
source§impl Clone for PutAlarmFluentBuilder
impl Clone for PutAlarmFluentBuilder
source§fn clone(&self) -> PutAlarmFluentBuilder
fn clone(&self) -> PutAlarmFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for PutAlarmFluentBuilder
impl !RefUnwindSafe for PutAlarmFluentBuilder
impl Send for PutAlarmFluentBuilder
impl Sync for PutAlarmFluentBuilder
impl Unpin for PutAlarmFluentBuilder
impl !UnwindSafe for PutAlarmFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more