1.204.0

interface MetricsCollectionProperty

LanguageType name
.NETAmazon.CDK.AWS.AutoScaling.CfnAutoScalingGroup.MetricsCollectionProperty
Javasoftware.amazon.awscdk.services.autoscaling.CfnAutoScalingGroup.MetricsCollectionProperty
Pythonaws_cdk.aws_autoscaling.CfnAutoScalingGroup.MetricsCollectionProperty
TypeScript @aws-cdk/aws-autoscaling » CfnAutoScalingGroup » MetricsCollectionProperty

MetricsCollection is a property of the AWS::AutoScaling::AutoScalingGroup resource that describes the group metrics that an Amazon EC2 Auto Scaling group sends to Amazon CloudWatch. These metrics describe the group rather than any of its instances.

For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide . You can find a sample template snippet in the Examples section of the AWS::AutoScaling::AutoScalingGroup resource.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as autoscaling from '@aws-cdk/aws-autoscaling';
const metricsCollectionProperty: autoscaling.CfnAutoScalingGroup.MetricsCollectionProperty = {
  granularity: 'granularity',

  // the properties below are optional
  metrics: ['metrics'],
};

Properties

NameTypeDescription
granularitystringThe frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch.
metrics?string[]Identifies the metrics to enable.

granularity

Type: string

The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch.

The only valid value is 1Minute .

metrics?

Type: string[] (optional)

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 .

← PreviousNext →