io.cloudshiftdev.awscdk.services.autoscaling.GroupMetric.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-cdk-wrapper Show documentation
Kotlin DSL for AWS CDK
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package io.cloudshiftdev.awscdk.services.autoscaling

import io.cloudshiftdev.awscdk.common.CdkObject
import kotlin.String

/**
 * 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();
 * ```
 */
public open class GroupMetric(
  cdkObject: software.amazon.awscdk.services.autoscaling.GroupMetric,
) : CdkObject(cdkObject) {
  public constructor(name: String) :
      this(software.amazon.awscdk.services.autoscaling.GroupMetric(name)
  )

  /**
   * The name of the group metric.
   */
  public open fun name(): String = unwrap(this).getName()

  public companion object {
    public val DESIRED_CAPACITY: GroupMetric =
        GroupMetric.wrap(software.amazon.awscdk.services.autoscaling.GroupMetric.DESIRED_CAPACITY)

    public val IN_SERVICE_INSTANCES: GroupMetric =
        GroupMetric.wrap(software.amazon.awscdk.services.autoscaling.GroupMetric.IN_SERVICE_INSTANCES)

    public val MAX_SIZE: GroupMetric =
        GroupMetric.wrap(software.amazon.awscdk.services.autoscaling.GroupMetric.MAX_SIZE)

    public val MIN_SIZE: GroupMetric =
        GroupMetric.wrap(software.amazon.awscdk.services.autoscaling.GroupMetric.MIN_SIZE)

    public val PENDING_INSTANCES: GroupMetric =
        GroupMetric.wrap(software.amazon.awscdk.services.autoscaling.GroupMetric.PENDING_INSTANCES)

    public val STANDBY_INSTANCES: GroupMetric =
        GroupMetric.wrap(software.amazon.awscdk.services.autoscaling.GroupMetric.STANDBY_INSTANCES)

    public val TERMINATING_INSTANCES: GroupMetric =
        GroupMetric.wrap(software.amazon.awscdk.services.autoscaling.GroupMetric.TERMINATING_INSTANCES)

    public val TOTAL_INSTANCES: GroupMetric =
        GroupMetric.wrap(software.amazon.awscdk.services.autoscaling.GroupMetric.TOTAL_INSTANCES)

    internal fun wrap(cdkObject: software.amazon.awscdk.services.autoscaling.GroupMetric):
        GroupMetric = GroupMetric(cdkObject)

    internal fun unwrap(wrapped: GroupMetric):
        software.amazon.awscdk.services.autoscaling.GroupMetric = wrapped.cdkObject as
        software.amazon.awscdk.services.autoscaling.GroupMetric
  }
}