[ aws . autoscaling ]

enable-metrics-collection

Description

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring CloudWatch metrics for 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 | --cli-input-yaml]
[--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

The warm pools feature supports the following additional metrics:

• WarmPoolDesiredCapacity

• WarmPoolWarmedCapacity

• WarmPoolPendingCapacity

• WarmPoolTerminatingCapacity

• WarmPoolTotalCapacity

• GroupAndWarmPoolDesiredCapacity

• GroupAndWarmPoolTotalCapacity

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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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

Example 1: 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-asg \
    --granularity "1Minute"

This command produces no output.

For more information, see Monitoring CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

Example 2: To collect data for the scpecified metric for an Auto Scaling group

To collect data for a specific metric, use the --metrics option.

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

This command produces no output.

For more information, see Monitoring CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

Output

None