autoscaling_enable_metrics_collection: Enables group metrics for the specified Auto Scaling group

Description Usage Arguments Value Request syntax Examples

View source: R/autoscaling_operations.R

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.

Usage

1
2
autoscaling_enable_metrics_collection(AutoScalingGroupName, Metrics,
  Granularity)

Arguments

AutoScalingGroupName

[required] The name of the Auto Scaling group.

Metrics

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.

Granularity

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

Value

An empty list.

Request syntax

1
2
3
4
5
6
7
svc$enable_metrics_collection(
  AutoScalingGroupName = "string",
  Metrics = list(
    "string"
  ),
  Granularity = "string"
)

Examples

1
2
3
4
5
6
7
8
9
## 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)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.