Package software.amazon.awscdk.services.autoscaling

Interface CfnAutoScalingGroup.MetricsCollectionProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnAutoScalingGroup.MetricsCollectionProperty.Jsii$Proxy
Enclosing class:
CfnAutoScalingGroup
@Stability(Stable) public static interface CfnAutoScalingGroup.MetricsCollectionProperty extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.autoscaling.*;
 MetricsCollectionProperty metricsCollectionProperty = MetricsCollectionProperty.builder()
         .granularity("granularity")
         // the properties below are optional
         .metrics(List.of("metrics"))
         .build();

  • Method Details

    • getGranularity

      @Stability(Stable) @NotNull String getGranularity()
      The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch.

      The only valid value is 1Minute .

    • getMetrics

      @Stability(Stable) @Nullable default List<String> getMetrics()
      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 .

    • builder

      @Stability(Stable) static CfnAutoScalingGroup.MetricsCollectionProperty.Builder builder()
      Returns:
      a CfnAutoScalingGroup.MetricsCollectionProperty.Builder of CfnAutoScalingGroup.MetricsCollectionProperty