#[non_exhaustive]pub struct AwsCloudWatchAlarmDetails {Show 22 fields
pub actions_enabled: Option<bool>,
pub alarm_actions: Option<Vec<String>>,
pub alarm_arn: Option<String>,
pub alarm_configuration_updated_timestamp: Option<String>,
pub alarm_description: Option<String>,
pub alarm_name: Option<String>,
pub comparison_operator: Option<String>,
pub datapoints_to_alarm: Option<i32>,
pub dimensions: Option<Vec<AwsCloudWatchAlarmDimensionsDetails>>,
pub evaluate_low_sample_count_percentile: Option<String>,
pub evaluation_periods: Option<i32>,
pub extended_statistic: Option<String>,
pub insufficient_data_actions: Option<Vec<String>>,
pub metric_name: Option<String>,
pub namespace: Option<String>,
pub ok_actions: Option<Vec<String>>,
pub period: Option<i32>,
pub statistic: Option<String>,
pub threshold: Option<f64>,
pub threshold_metric_id: Option<String>,
pub treat_missing_data: Option<String>,
pub unit: Option<String>,
}Expand description
Specifies an alarm and associates it with the specified metric or metric math expression.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.actions_enabled: Option<bool>Indicates whether actions should be executed during any changes to the alarm state.
alarm_actions: Option<Vec<String>>The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other state.
alarm_arn: Option<String>The ARN of the alarm.
alarm_configuration_updated_timestamp: Option<String>The time stamp of the last update to the alarm configuration.
alarm_description: Option<String>The description of the alarm.
alarm_name: Option<String>The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the alarm name.
comparison_operator: Option<String>The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
datapoints_to_alarm: Option<i32>The number of datapoints that must be breaching to trigger the alarm.
dimensions: Option<Vec<AwsCloudWatchAlarmDimensionsDetails>>The dimensions for the metric associated with the alarm.
evaluate_low_sample_count_percentile: Option<String>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.
evaluation_periods: Option<i32>The number of periods over which data is compared to the specified threshold.
extended_statistic: Option<String>The percentile statistic for the metric associated with the alarm.
insufficient_data_actions: Option<Vec<String>>The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an ARN.
metric_name: Option<String>The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.
namespace: Option<String>The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.
ok_actions: Option<Vec<String>>The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an ARN.
period: Option<i32>The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.
statistic: Option<String>The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.
threshold: Option<f64>The value to compare with the specified statistic.
threshold_metric_id: Option<String>n 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.
treat_missing_data: Option<String>Sets how this alarm is to handle missing data points.
unit: Option<String>The unit of the metric associated with the alarm.
Implementations§
Source§impl AwsCloudWatchAlarmDetails
impl AwsCloudWatchAlarmDetails
Sourcepub fn actions_enabled(&self) -> Option<bool>
pub fn actions_enabled(&self) -> Option<bool>
Indicates whether actions should be executed during any changes to the alarm state.
Sourcepub fn alarm_actions(&self) -> &[String]
pub fn alarm_actions(&self) -> &[String]
The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other state.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .alarm_actions.is_none().
Sourcepub fn alarm_configuration_updated_timestamp(&self) -> Option<&str>
pub fn alarm_configuration_updated_timestamp(&self) -> Option<&str>
The time stamp of the last update to the alarm configuration.
Sourcepub fn alarm_description(&self) -> Option<&str>
pub fn alarm_description(&self) -> Option<&str>
The description of the alarm.
Sourcepub fn alarm_name(&self) -> Option<&str>
pub fn alarm_name(&self) -> Option<&str>
The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the alarm name.
Sourcepub fn comparison_operator(&self) -> Option<&str>
pub fn comparison_operator(&self) -> Option<&str>
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
Sourcepub fn datapoints_to_alarm(&self) -> Option<i32>
pub fn datapoints_to_alarm(&self) -> Option<i32>
The number of datapoints that must be breaching to trigger the alarm.
Sourcepub fn dimensions(&self) -> &[AwsCloudWatchAlarmDimensionsDetails]
pub fn dimensions(&self) -> &[AwsCloudWatchAlarmDimensionsDetails]
The dimensions for the metric associated with the alarm.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .dimensions.is_none().
Sourcepub fn evaluate_low_sample_count_percentile(&self) -> Option<&str>
pub fn evaluate_low_sample_count_percentile(&self) -> Option<&str>
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.
Sourcepub fn evaluation_periods(&self) -> Option<i32>
pub fn evaluation_periods(&self) -> Option<i32>
The number of periods over which data is compared to the specified threshold.
Sourcepub fn extended_statistic(&self) -> Option<&str>
pub fn extended_statistic(&self) -> Option<&str>
The percentile statistic for the metric associated with the alarm.
Sourcepub fn insufficient_data_actions(&self) -> &[String]
pub fn insufficient_data_actions(&self) -> &[String]
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an ARN.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .insufficient_data_actions.is_none().
Sourcepub fn metric_name(&self) -> Option<&str>
pub fn metric_name(&self) -> Option<&str>
The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.
Sourcepub fn namespace(&self) -> Option<&str>
pub fn namespace(&self) -> Option<&str>
The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.
Sourcepub fn ok_actions(&self) -> &[String]
pub fn ok_actions(&self) -> &[String]
The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an ARN.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ok_actions.is_none().
Sourcepub fn period(&self) -> Option<i32>
pub fn period(&self) -> Option<i32>
The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.
Sourcepub fn statistic(&self) -> Option<&str>
pub fn statistic(&self) -> Option<&str>
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.
Sourcepub fn threshold_metric_id(&self) -> Option<&str>
pub fn threshold_metric_id(&self) -> Option<&str>
n 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.
Sourcepub fn treat_missing_data(&self) -> Option<&str>
pub fn treat_missing_data(&self) -> Option<&str>
Sets how this alarm is to handle missing data points.
Source§impl AwsCloudWatchAlarmDetails
impl AwsCloudWatchAlarmDetails
Sourcepub fn builder() -> AwsCloudWatchAlarmDetailsBuilder
pub fn builder() -> AwsCloudWatchAlarmDetailsBuilder
Creates a new builder-style object to manufacture AwsCloudWatchAlarmDetails.
Trait Implementations§
Source§impl Clone for AwsCloudWatchAlarmDetails
impl Clone for AwsCloudWatchAlarmDetails
Source§fn clone(&self) -> AwsCloudWatchAlarmDetails
fn clone(&self) -> AwsCloudWatchAlarmDetails
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for AwsCloudWatchAlarmDetails
impl Debug for AwsCloudWatchAlarmDetails
impl StructuralPartialEq for AwsCloudWatchAlarmDetails
Auto Trait Implementations§
impl Freeze for AwsCloudWatchAlarmDetails
impl RefUnwindSafe for AwsCloudWatchAlarmDetails
impl Send for AwsCloudWatchAlarmDetails
impl Sync for AwsCloudWatchAlarmDetails
impl Unpin for AwsCloudWatchAlarmDetails
impl UnwindSafe for AwsCloudWatchAlarmDetails
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);