Struct aws_sdk_cloudwatch::model::MetricAlarm

#[non_exhaustive]
pub struct MetricAlarm {

    pub alarm_name: Option<String>,
    pub alarm_arn: Option<String>,
    pub alarm_description: Option<String>,
    pub alarm_configuration_updated_timestamp: Option<Instant>,
    pub actions_enabled: Option<bool>,
    pub ok_actions: Option<Vec<String>>,
    pub alarm_actions: Option<Vec<String>>,
    pub insufficient_data_actions: Option<Vec<String>>,
    pub state_value: Option<StateValue>,
    pub state_reason: Option<String>,
    pub state_reason_data: Option<String>,
    pub state_updated_timestamp: Option<Instant>,
    pub metric_name: Option<String>,
    pub namespace: Option<String>,
    pub statistic: Option<Statistic>,
    pub extended_statistic: Option<String>,
    pub dimensions: Option<Vec<Dimension>>,
    pub period: Option<i32>,
    pub unit: Option<StandardUnit>,
    pub evaluation_periods: Option<i32>,
    pub datapoints_to_alarm: Option<i32>,
    pub threshold: Option<f64>,
    pub comparison_operator: Option<ComparisonOperator>,
    pub treat_missing_data: Option<String>,
    pub evaluate_low_sample_count_percentile: Option<String>,
    pub metrics: Option<Vec<MetricDataQuery>>,
    pub threshold_metric_id: Option<String>,
}

The details about a metric alarm.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

alarm_name: Option<String>

The name of the alarm.

alarm_arn: Option<String>

The Amazon Resource Name (ARN) of the alarm.

alarm_description: Option<String>

The description of the alarm.

alarm_configuration_updated_timestamp: Option<Instant>

The time stamp of the last update to the alarm configuration.

actions_enabled: Option<bool>

Indicates whether actions should be executed during any changes to the alarm state.

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 Amazon Resource Name (ARN).

alarm_actions: Option<Vec<String>>

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

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 Amazon Resource Name (ARN).

state_value: Option<StateValue>

The state value for the alarm.

state_reason: Option<String>

An explanation for the alarm state, in text format.

state_reason_data: Option<String>

An explanation for the alarm state, in JSON format.

state_updated_timestamp: Option<Instant>

The time stamp of the last update to the alarm state.

metric_name: Option<String>

The name of the metric associated with the alarm, if this is an alarm based on a single metric.

namespace: Option<String>

The namespace of the metric associated with the alarm.

statistic: Option<Statistic>

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

extended_statistic: Option<String>

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

dimensions: Option<Vec<Dimension>>

The dimensions for the metric associated with the alarm.

period: Option<i32>

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

unit: Option<StandardUnit>

The unit of the metric associated with the alarm.

evaluation_periods: Option<i32>

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

datapoints_to_alarm: Option<i32>

The number of data points that must be breaching to trigger the alarm.

threshold: Option<f64>

The value to compare with the specified statistic.

comparison_operator: Option<ComparisonOperator>

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

treat_missing_data: Option<String>

Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.

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.

metrics: Option<Vec<MetricDataQuery>>

An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression.

One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnData set to true.

threshold_metric_id: Option<String>

In 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.

Implementations

impl MetricAlarm

pub fn alarm_name(&self) -> Option<&str>

The name of the alarm.

pub fn alarm_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the alarm.

pub fn alarm_description(&self) -> Option<&str>

The description of the alarm.

pub fn alarm_configuration_updated_timestamp(&self) -> Option<&Instant>

The time stamp of the last update to the alarm configuration.

pub fn actions_enabled(&self) -> Option<bool>

Indicates whether actions should be executed during any changes to the alarm state.

pub fn ok_actions(&self) -> Option<&[String]>

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

pub fn alarm_actions(&self) -> Option<&[String]>

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

pub fn insufficient_data_actions(&self) -> Option<&[String]>

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

pub fn state_value(&self) -> Option<&StateValue>

The state value for the alarm.

pub fn state_reason(&self) -> Option<&str>

An explanation for the alarm state, in text format.

pub fn state_reason_data(&self) -> Option<&str>

An explanation for the alarm state, in JSON format.

pub fn state_updated_timestamp(&self) -> Option<&Instant>

The time stamp of the last update to the alarm state.

pub fn metric_name(&self) -> Option<&str>

The name of the metric associated with the alarm, if this is an alarm based on a single metric.

pub fn namespace(&self) -> Option<&str>

The namespace of the metric associated with the alarm.

pub fn statistic(&self) -> Option<&Statistic>

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

pub fn extended_statistic(&self) -> Option<&str>

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

pub fn dimensions(&self) -> Option<&[Dimension]>

The dimensions for the metric associated with the alarm.

pub fn period(&self) -> Option<i32>

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

pub fn unit(&self) -> Option<&StandardUnit>

The unit of the metric associated with the alarm.

pub fn evaluation_periods(&self) -> Option<i32>

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

pub fn datapoints_to_alarm(&self) -> Option<i32>

The number of data points that must be breaching to trigger the alarm.

pub fn threshold(&self) -> Option<f64>

The value to compare with the specified statistic.

pub fn comparison_operator(&self) -> Option<&ComparisonOperator>

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

pub fn treat_missing_data(&self) -> Option<&str>

Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.

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.

pub fn metrics(&self) -> Option<&[MetricDataQuery]>

An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression.

One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnData set to true.

pub fn threshold_metric_id(&self) -> Option<&str>

In 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.

impl MetricAlarm

pub fn builder() -> Builder

Creates a new builder-style object to manufacture MetricAlarm

Trait Implementations

impl Clone for MetricAlarm

fn clone(&self) -> MetricAlarm

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetricAlarm

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<MetricAlarm> for MetricAlarm

fn eq(&self, other: &MetricAlarm) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MetricAlarm) -> bool

This method tests for !=.

impl StructuralPartialEq for MetricAlarm