Struct aws_sdk_securityhub::types::AwsCloudWatchAlarmDetails

#[non_exhaustive]
pub struct AwsCloudWatchAlarmDetails {

    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>,
}

Specifies an alarm and associates it with the specified metric or metric math expression.

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.

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

impl AwsCloudWatchAlarmDetails

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

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

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().

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

The ARN of the alarm.

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

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

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

The description of the alarm.

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.

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.

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

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

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().

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 evaluation_periods(&self) -> Option<i32>

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

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

The percentile statistic for the metric associated with the alarm.

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().

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.

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.

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().

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.

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.

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

The value to compare with the specified statistic.

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.

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

Sets how this alarm is to handle missing data points.

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

The unit of the metric associated with the alarm.

impl AwsCloudWatchAlarmDetails

pub fn builder() -> AwsCloudWatchAlarmDetailsBuilder

Creates a new builder-style object to manufacture AwsCloudWatchAlarmDetails.

Trait Implementations

impl Clone for AwsCloudWatchAlarmDetails

fn clone(&self) -> AwsCloudWatchAlarmDetails

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AwsCloudWatchAlarmDetails

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

Formats the value using the given formatter.

impl PartialEq for AwsCloudWatchAlarmDetails

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AwsCloudWatchAlarmDetails