EnableMetricsCollectionRequest Class

Container for the parameters to the EnableMetricsCollection operation. Enables group metrics collection for the specified Auto Scaling group.

You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AutoScaling.AmazonAutoScalingRequest
      Amazon.AutoScaling.Model.EnableMetricsCollectionRequest

Namespace: Amazon.AutoScaling.Model
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z

Syntax

public class EnableMetricsCollectionRequest : AmazonAutoScalingRequest
         IAmazonWebServiceRequest

The EnableMetricsCollectionRequest type exposes the following members

Constructors

	Name	Description
	EnableMetricsCollectionRequest()

Properties

Name Type Description

Name	Type	Description
AutoScalingGroupName	System.String	Gets and sets the property AutoScalingGroupName. The name of the Auto Scaling group.
Granularity	System.String	Gets and sets the property Granularity. The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is `1Minute`.
Metrics	System.Collections.Generic.List<System.String>	Gets and sets the property Metrics. Identifies the metrics to enable. You can specify one or more of the following metrics: `GroupMinSize` `GroupMaxSize` `GroupDesiredCapacity` `GroupInServiceInstances` `GroupPendingInstances` `GroupStandbyInstances` `GroupTerminatingInstances` `GroupTotalInstances` `GroupInServiceCapacity` `GroupPendingCapacity` `GroupStandbyCapacity` `GroupTerminatingCapacity` `GroupTotalCapacity` `WarmPoolDesiredCapacity` `WarmPoolWarmedCapacity` `WarmPoolPendingCapacity` `WarmPoolTerminatingCapacity` `WarmPoolTotalCapacity` `GroupAndWarmPoolDesiredCapacity` `GroupAndWarmPoolTotalCapacity` If you specify `Granularity` and don't specify any metrics, all metrics are enabled. For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

AutoScalingGroupName

System.String

Gets and sets the property AutoScalingGroupName.

The name of the Auto Scaling group.

Granularity

System.String

Gets and sets the property Granularity.

The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is 1Minute.

Metrics

System.Collections.Generic.List<System.String>

Gets and sets the property Metrics.

Identifies the metrics to enable.

You can specify one or more of the following metrics:

GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity

If you specify Granularity and don't specify any metrics, all metrics are enabled.

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

Examples

This example enables data collection for the specified Auto Scaling group.

To enable metrics collection for an Auto Scaling group


var client = new AmazonAutoScalingClient();
var response = client.EnableMetricsCollection(new EnableMetricsCollectionRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    Granularity = "1Minute"
});

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5