Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . autoscaling ]

enable-metrics-collection

Description

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  enable-metrics-collection
--auto-scaling-group-name <value>
[--metrics <value>]
--granularity <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--auto-scaling-group-name (string)

The name of the Auto Scaling group.

--metrics (list)

Specifies which group-level metrics to start collecting. You can specify one or more of the following metrics:

  • GroupMinSize
  • GroupMaxSize
  • GroupDesiredCapacity
  • GroupInServiceInstances
  • GroupPendingInstances
  • GroupStandbyInstances
  • GroupTerminatingInstances
  • GroupTotalInstances

The instance weighting feature supports the following additional metrics:

  • GroupInServiceCapacity
  • GroupPendingCapacity
  • GroupStandbyCapacity
  • GroupTerminatingCapacity
  • GroupTotalCapacity

If you omit this parameter, all metrics are enabled.

(string)

Syntax:

"string" "string" ...

--granularity (string)

The granularity to associate with the metrics to collect. The only valid value is 1Minute .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To enable metrics collection for an Auto Scaling group

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

aws autoscaling enable-metrics-collection --auto-scaling-group-name my-auto-scaling-group --granularity "1Minute"

To collect data for a specific metric, use the metrics parameter:

aws autoscaling enable-metrics-collection --auto-scaling-group-name my-auto-scaling-group --metrics GroupDesiredCapacity --granularity "1Minute"

For more information, see Monitoring Your Auto Scaling Groups and Instances Using Amazon CloudWatch in the Amazon EC2 Auto Scaling User Guide.

Output

None