Struct aws_sdk_emr::types::CloudWatchAlarmDefinition

#[non_exhaustive]
pub struct CloudWatchAlarmDefinition {
    pub comparison_operator: Option<ComparisonOperator>,
    pub evaluation_periods: Option<i32>,
    pub metric_name: Option<String>,
    pub namespace: Option<String>,
    pub period: Option<i32>,
    pub statistic: Option<Statistic>,
    pub threshold: Option<f64>,
    pub unit: Option<Unit>,
    pub dimensions: Option<Vec<MetricDimension>>,
}

The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.

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.

comparison_operator: Option<ComparisonOperator>

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

evaluation_periods: Option<i32>

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

metric_name: Option<String>

The name of the CloudWatch metric that is watched to determine an alarm condition.

namespace: Option<String>

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

period: Option<i32>

The period, in seconds, over which the statistic is applied. CloudWatch metrics for Amazon EMR are emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify 300.

statistic: Option<Statistic>

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

threshold: Option<f64>

The value against which the specified statistic is compared.

unit: Option<Unit>

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

dimensions: Option<Vec<MetricDimension>>

A CloudWatch metric dimension.

Implementations

impl CloudWatchAlarmDefinition

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

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

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

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

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

The name of the CloudWatch metric that is watched to determine an alarm condition.

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

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

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

The period, in seconds, over which the statistic is applied. CloudWatch metrics for Amazon EMR are emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify 300.

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

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

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

The value against which the specified statistic is compared.

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

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

pub fn dimensions(&self) -> &[MetricDimension]

A CloudWatch metric dimension.

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

impl CloudWatchAlarmDefinition

pub fn builder() -> CloudWatchAlarmDefinitionBuilder

Creates a new builder-style object to manufacture CloudWatchAlarmDefinition.

Trait Implementations

impl Clone for CloudWatchAlarmDefinition

fn clone(&self) -> CloudWatchAlarmDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CloudWatchAlarmDefinition

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

Formats the value using the given formatter.

impl PartialEq for CloudWatchAlarmDefinition

fn eq(&self, other: &CloudWatchAlarmDefinition) -> 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 CloudWatchAlarmDefinition