Package software.amazon.awscdk.services.autoscaling

Class GroupMetric

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.autoscaling.GroupMetric
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:45.368Z") @Stability(Stable) public class GroupMetric extends software.amazon.jsii.JsiiObject
Group metrics that an Auto Scaling group sends to Amazon CloudWatch.

Example: 

 Vpc vpc;
 InstanceType instanceType;
 IMachineImage machineImage;
 // Enable monitoring of all group metrics
 // Enable monitoring of all group metrics
 AutoScalingGroup.Builder.create(this, "ASG")
         .vpc(vpc)
         .instanceType(instanceType)
         .machineImage(machineImage)
         // ...
         .groupMetrics(List.of(GroupMetrics.all()))
         .build();
 // Enable monitoring for a subset of group metrics
 // Enable monitoring for a subset of group metrics
 AutoScalingGroup.Builder.create(this, "ASG")
         .vpc(vpc)
         .instanceType(instanceType)
         .machineImage(machineImage)
         // ...
         .groupMetrics(List.of(new GroupMetrics(GroupMetric.MIN_SIZE, GroupMetric.MAX_SIZE)))
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final GroupMetric
    DESIRED_CAPACITY
    The number of instances that the Auto Scaling group attempts to maintain.
    static final GroupMetric
    IN_SERVICE_INSTANCES
    The number of instances that are running as part of the Auto Scaling group This metric does not include instances that are pending or terminating.
    static final GroupMetric
    MAX_SIZE
    The maximum size of the Auto Scaling group.
    static final GroupMetric
    MIN_SIZE
    The minimum size of the Auto Scaling group.
    static final GroupMetric
    PENDING_INSTANCES
    The number of instances that are pending A pending instance is not yet in service, this metric does not include instances that are in service or terminating.
    static final GroupMetric
    STANDBY_INSTANCES
    The number of instances that are in a Standby state Instances in this state are still running but are not actively in service.
    static final GroupMetric
    TERMINATING_INSTANCES
    The number of instances that are in the process of terminating This metric does not include instances that are in service or pending.
    static final GroupMetric
    TOTAL_INSTANCES
    The total number of instances in the Auto Scaling group This metric identifies the number of instances that are in service, pending, and terminating.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    GroupMetric(String name)
     
    protected
    GroupMetric(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    GroupMetric(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    The name of the group metric.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • DESIRED_CAPACITY

      @Stability(Stable) public static final GroupMetric DESIRED_CAPACITY
      The number of instances that the Auto Scaling group attempts to maintain.

    • IN_SERVICE_INSTANCES

      @Stability(Stable) public static final GroupMetric IN_SERVICE_INSTANCES
      The number of instances that are running as part of the Auto Scaling group This metric does not include instances that are pending or terminating.

    • MAX_SIZE

      @Stability(Stable) public static final GroupMetric MAX_SIZE
      The maximum size of the Auto Scaling group.

    • MIN_SIZE

      @Stability(Stable) public static final GroupMetric MIN_SIZE
      The minimum size of the Auto Scaling group.

    • PENDING_INSTANCES

      @Stability(Stable) public static final GroupMetric PENDING_INSTANCES
      The number of instances that are pending A pending instance is not yet in service, this metric does not include instances that are in service or terminating.

    • STANDBY_INSTANCES

      @Stability(Stable) public static final GroupMetric STANDBY_INSTANCES
      The number of instances that are in a Standby state Instances in this state are still running but are not actively in service.

    • TERMINATING_INSTANCES

      @Stability(Stable) public static final GroupMetric TERMINATING_INSTANCES
      The number of instances that are in the process of terminating This metric does not include instances that are in service or pending.

    • TOTAL_INSTANCES

      @Stability(Stable) public static final GroupMetric TOTAL_INSTANCES
      The total number of instances in the Auto Scaling group This metric identifies the number of instances that are in service, pending, and terminating.

  • Constructor Details

    • GroupMetric

      protected GroupMetric(software.amazon.jsii.JsiiObjectRef objRef)

    • GroupMetric

      protected GroupMetric(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • GroupMetric

      @Stability(Stable) public GroupMetric(@NotNull String name)
      Parameters:
      name - This parameter is required.

  • Method Details

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the group metric.