io.cloudshiftdev.awscdk.services.autoscaling.WarmPoolOptions.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
There is a newer version: 0.10.0
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package io.cloudshiftdev.awscdk.services.autoscaling

import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.Boolean
import kotlin.Number
import kotlin.Unit

/**
 * Options for a warm pool.
 *
 * Example:
 *
 * ```
 * AutoScalingGroup autoScalingGroup;
 * autoScalingGroup.addWarmPool(WarmPoolOptions.builder()
 * .minSize(1)
 * .reuseOnScaleIn(true)
 * .build());
 * ```
 */
public interface WarmPoolOptions {
  /**
   * The maximum number of instances that are allowed to be in the warm pool or in any state except
   * Terminated for the Auto Scaling group.
   *
   * If the value is not specified, Amazon EC2 Auto Scaling launches and maintains
   * the difference between the group's maximum capacity and its desired capacity.
   *
   * Default: - max size of the Auto Scaling group
   */
  public fun maxGroupPreparedCapacity(): Number? = unwrap(this).getMaxGroupPreparedCapacity()

  /**
   * The minimum number of instances to maintain in the warm pool.
   *
   * Default: 0
   */
  public fun minSize(): Number? = unwrap(this).getMinSize()

  /**
   * The instance state to transition to after the lifecycle actions are complete.
   *
   * Default: PoolState.STOPPED
   */
  public fun poolState(): PoolState? = unwrap(this).getPoolState()?.let(PoolState::wrap)

  /**
   * Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale
   * in.
   *
   * If the value is not specified, instances in the Auto Scaling group will be terminated
   * when the group scales in.
   *
   * Default: false
   */
  public fun reuseOnScaleIn(): Boolean? = unwrap(this).getReuseOnScaleIn()

  /**
   * A builder for [WarmPoolOptions]
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * @param maxGroupPreparedCapacity The maximum number of instances that are allowed to be in the
     * warm pool or in any state except Terminated for the Auto Scaling group.
     * If the value is not specified, Amazon EC2 Auto Scaling launches and maintains
     * the difference between the group's maximum capacity and its desired capacity.
     */
    public fun maxGroupPreparedCapacity(maxGroupPreparedCapacity: Number)

    /**
     * @param minSize The minimum number of instances to maintain in the warm pool.
     */
    public fun minSize(minSize: Number)

    /**
     * @param poolState The instance state to transition to after the lifecycle actions are
     * complete.
     */
    public fun poolState(poolState: PoolState)

    /**
     * @param reuseOnScaleIn Indicates whether instances in the Auto Scaling group can be returned
     * to the warm pool on scale in.
     * If the value is not specified, instances in the Auto Scaling group will be terminated
     * when the group scales in.
     */
    public fun reuseOnScaleIn(reuseOnScaleIn: Boolean)
  }

  private class BuilderImpl : Builder {
    private val cdkBuilder: software.amazon.awscdk.services.autoscaling.WarmPoolOptions.Builder =
        software.amazon.awscdk.services.autoscaling.WarmPoolOptions.builder()

    /**
     * @param maxGroupPreparedCapacity The maximum number of instances that are allowed to be in the
     * warm pool or in any state except Terminated for the Auto Scaling group.
     * If the value is not specified, Amazon EC2 Auto Scaling launches and maintains
     * the difference between the group's maximum capacity and its desired capacity.
     */
    override fun maxGroupPreparedCapacity(maxGroupPreparedCapacity: Number) {
      cdkBuilder.maxGroupPreparedCapacity(maxGroupPreparedCapacity)
    }

    /**
     * @param minSize The minimum number of instances to maintain in the warm pool.
     */
    override fun minSize(minSize: Number) {
      cdkBuilder.minSize(minSize)
    }

    /**
     * @param poolState The instance state to transition to after the lifecycle actions are
     * complete.
     */
    override fun poolState(poolState: PoolState) {
      cdkBuilder.poolState(poolState.let(PoolState.Companion::unwrap))
    }

    /**
     * @param reuseOnScaleIn Indicates whether instances in the Auto Scaling group can be returned
     * to the warm pool on scale in.
     * If the value is not specified, instances in the Auto Scaling group will be terminated
     * when the group scales in.
     */
    override fun reuseOnScaleIn(reuseOnScaleIn: Boolean) {
      cdkBuilder.reuseOnScaleIn(reuseOnScaleIn)
    }

    public fun build(): software.amazon.awscdk.services.autoscaling.WarmPoolOptions =
        cdkBuilder.build()
  }

  private class Wrapper(
    cdkObject: software.amazon.awscdk.services.autoscaling.WarmPoolOptions,
  ) : CdkObject(cdkObject),
      WarmPoolOptions {
    /**
     * The maximum number of instances that are allowed to be in the warm pool or in any state
     * except Terminated for the Auto Scaling group.
     *
     * If the value is not specified, Amazon EC2 Auto Scaling launches and maintains
     * the difference between the group's maximum capacity and its desired capacity.
     *
     * Default: - max size of the Auto Scaling group
     */
    override fun maxGroupPreparedCapacity(): Number? = unwrap(this).getMaxGroupPreparedCapacity()

    /**
     * The minimum number of instances to maintain in the warm pool.
     *
     * Default: 0
     */
    override fun minSize(): Number? = unwrap(this).getMinSize()

    /**
     * The instance state to transition to after the lifecycle actions are complete.
     *
     * Default: PoolState.STOPPED
     */
    override fun poolState(): PoolState? = unwrap(this).getPoolState()?.let(PoolState::wrap)

    /**
     * Indicates whether instances in the Auto Scaling group can be returned to the warm pool on
     * scale in.
     *
     * If the value is not specified, instances in the Auto Scaling group will be terminated
     * when the group scales in.
     *
     * Default: false
     */
    override fun reuseOnScaleIn(): Boolean? = unwrap(this).getReuseOnScaleIn()
  }

  public companion object {
    public operator fun invoke(block: Builder.() -> Unit = {}): WarmPoolOptions {
      val builderImpl = BuilderImpl()
      return Wrapper(builderImpl.apply(block).build())
    }

    internal fun wrap(cdkObject: software.amazon.awscdk.services.autoscaling.WarmPoolOptions):
        WarmPoolOptions = CdkObjectWrappers.wrap(cdkObject) as? WarmPoolOptions ?:
        Wrapper(cdkObject)

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