Enable Metrics Collection

autoscaling_enable_metrics_collection

R Documentation

Enables group metrics collection for the specified Auto Scaling group¶

Description¶

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.

Usage¶

autoscaling_enable_metrics_collection(AutoScalingGroupName, Metrics,
  Granularity)

Arguments¶

AutoScalingGroupName

[required] The name of the Auto Scaling group.

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 Amazon CloudWatch metrics for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Granularity

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

Value¶

An empty list.

Request syntax¶

svc$enable_metrics_collection(
  AutoScalingGroupName = "string",
  Metrics = list(
    "string"
  ),
  Granularity = "string"
)

Examples¶

## Not run: 
# This example enables data collection for the specified Auto Scaling
# group.
svc$enable_metrics_collection(
  AutoScalingGroupName = "my-auto-scaling-group",
  Granularity = "1Minute"
)

## End(Not run)