aws_sdk_autoscaling/client/
enable_metrics_collection.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`EnableMetricsCollection`](crate::operation::enable_metrics_collection::builders::EnableMetricsCollectionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`auto_scaling_group_name(impl Into<String>)`](crate::operation::enable_metrics_collection::builders::EnableMetricsCollectionFluentBuilder::auto_scaling_group_name) / [`set_auto_scaling_group_name(Option<String>)`](crate::operation::enable_metrics_collection::builders::EnableMetricsCollectionFluentBuilder::set_auto_scaling_group_name):<br>required: **true**<br><p>The name of the Auto Scaling group.</p><br>
7    ///   - [`metrics(impl Into<String>)`](crate::operation::enable_metrics_collection::builders::EnableMetricsCollectionFluentBuilder::metrics) / [`set_metrics(Option<Vec::<String>>)`](crate::operation::enable_metrics_collection::builders::EnableMetricsCollectionFluentBuilder::set_metrics):<br>required: **false**<br><p>Identifies the metrics to enable.</p> <p>You can specify one or more of the following metrics:</p> <ul>  <li>   <p><code>GroupMinSize</code></p></li>  <li>   <p><code>GroupMaxSize</code></p></li>  <li>   <p><code>GroupDesiredCapacity</code></p></li>  <li>   <p><code>GroupInServiceInstances</code></p></li>  <li>   <p><code>GroupPendingInstances</code></p></li>  <li>   <p><code>GroupStandbyInstances</code></p></li>  <li>   <p><code>GroupTerminatingInstances</code></p></li>  <li>   <p><code>GroupTotalInstances</code></p></li>  <li>   <p><code>GroupInServiceCapacity</code></p></li>  <li>   <p><code>GroupPendingCapacity</code></p></li>  <li>   <p><code>GroupStandbyCapacity</code></p></li>  <li>   <p><code>GroupTerminatingCapacity</code></p></li>  <li>   <p><code>GroupTotalCapacity</code></p></li>  <li>   <p><code>WarmPoolDesiredCapacity</code></p></li>  <li>   <p><code>WarmPoolWarmedCapacity</code></p></li>  <li>   <p><code>WarmPoolPendingCapacity</code></p></li>  <li>   <p><code>WarmPoolTerminatingCapacity</code></p></li>  <li>   <p><code>WarmPoolTotalCapacity</code></p></li>  <li>   <p><code>GroupAndWarmPoolDesiredCapacity</code></p></li>  <li>   <p><code>GroupAndWarmPoolTotalCapacity</code></p></li> </ul> <p>If you specify <code>Granularity</code> and don't specify any metrics, all metrics are enabled.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-metrics.html">Amazon CloudWatch metrics for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p><br>
8    ///   - [`granularity(impl Into<String>)`](crate::operation::enable_metrics_collection::builders::EnableMetricsCollectionFluentBuilder::granularity) / [`set_granularity(Option<String>)`](crate::operation::enable_metrics_collection::builders::EnableMetricsCollectionFluentBuilder::set_granularity):<br>required: **true**<br><p>The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is <code>1Minute</code>.</p><br>
9    /// - On success, responds with [`EnableMetricsCollectionOutput`](crate::operation::enable_metrics_collection::EnableMetricsCollectionOutput)
10    /// - On failure, responds with [`SdkError<EnableMetricsCollectionError>`](crate::operation::enable_metrics_collection::EnableMetricsCollectionError)
11    pub fn enable_metrics_collection(&self) -> crate::operation::enable_metrics_collection::builders::EnableMetricsCollectionFluentBuilder {
12        crate::operation::enable_metrics_collection::builders::EnableMetricsCollectionFluentBuilder::new(self.handle.clone())
13    }
14}