io.cloudshiftdev.awscdk.services.dynamodb.AutoscaledCapacityOptions.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.dynamodb

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

/**
 * Options used to configure autoscaled capacity.
 *
 * Example:
 *
 * ```
 * import io.cloudshiftdev.awscdk.*;
 * App app = new App();
 * Stack stack = Stack.Builder.create(app,
 * "Stack").env(Environment.builder().region("us-west-2").build()).build();
 * TableV2 globalTable = TableV2.Builder.create(stack, "GlobalTable")
 * .partitionKey(Attribute.builder().name("pk").type(AttributeType.STRING).build())
 * .billing(Billing.provisioned(ThroughputProps.builder()
 * .readCapacity(Capacity.fixed(10))
 * .writeCapacity(Capacity.autoscaled(AutoscaledCapacityOptions.builder().maxCapacity(15).build()))
 * .build()))
 * .replicas(List.of(ReplicaTableProps.builder()
 * .region("us-east-1")
 * .build(), ReplicaTableProps.builder()
 * .region("us-east-2")
 * .readCapacity(Capacity.autoscaled(AutoscaledCapacityOptions.builder().maxCapacity(20).targetUtilizationPercent(50).build()))
 * .build()))
 * .build();
 * ```
 */
public interface AutoscaledCapacityOptions {
  /**
   * The maximum allowable capacity.
   */
  public fun maxCapacity(): Number

  /**
   * The minimum allowable capacity.
   *
   * Default: 1
   */
  public fun minCapacity(): Number? = unwrap(this).getMinCapacity()

  /**
   * If you want to switch a table's billing mode from on-demand to provisioned or from provisioned
   * to on-demand, you must specify a value for this property for each autoscaled resource.
   *
   * Default: no seed capacity
   */
  public fun seedCapacity(): Number? = unwrap(this).getSeedCapacity()

  /**
   * The ratio of consumed capacity units to provisioned capacity units.
   *
   * Note: Target utilization percent cannot be less than 20 and cannot be greater
   * than 90.
   *
   * Default: 70
   */
  public fun targetUtilizationPercent(): Number? = unwrap(this).getTargetUtilizationPercent()

  /**
   * A builder for [AutoscaledCapacityOptions]
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * @param maxCapacity The maximum allowable capacity. 
     */
    public fun maxCapacity(maxCapacity: Number)

    /**
     * @param minCapacity The minimum allowable capacity.
     */
    public fun minCapacity(minCapacity: Number)

    /**
     * @param seedCapacity If you want to switch a table's billing mode from on-demand to
     * provisioned or from provisioned to on-demand, you must specify a value for this property for
     * each autoscaled resource.
     */
    public fun seedCapacity(seedCapacity: Number)

    /**
     * @param targetUtilizationPercent The ratio of consumed capacity units to provisioned capacity
     * units.
     * Note: Target utilization percent cannot be less than 20 and cannot be greater
     * than 90.
     */
    public fun targetUtilizationPercent(targetUtilizationPercent: Number)
  }

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

    /**
     * @param maxCapacity The maximum allowable capacity. 
     */
    override fun maxCapacity(maxCapacity: Number) {
      cdkBuilder.maxCapacity(maxCapacity)
    }

    /**
     * @param minCapacity The minimum allowable capacity.
     */
    override fun minCapacity(minCapacity: Number) {
      cdkBuilder.minCapacity(minCapacity)
    }

    /**
     * @param seedCapacity If you want to switch a table's billing mode from on-demand to
     * provisioned or from provisioned to on-demand, you must specify a value for this property for
     * each autoscaled resource.
     */
    override fun seedCapacity(seedCapacity: Number) {
      cdkBuilder.seedCapacity(seedCapacity)
    }

    /**
     * @param targetUtilizationPercent The ratio of consumed capacity units to provisioned capacity
     * units.
     * Note: Target utilization percent cannot be less than 20 and cannot be greater
     * than 90.
     */
    override fun targetUtilizationPercent(targetUtilizationPercent: Number) {
      cdkBuilder.targetUtilizationPercent(targetUtilizationPercent)
    }

    public fun build(): software.amazon.awscdk.services.dynamodb.AutoscaledCapacityOptions =
        cdkBuilder.build()
  }

  private class Wrapper(
    cdkObject: software.amazon.awscdk.services.dynamodb.AutoscaledCapacityOptions,
  ) : CdkObject(cdkObject),
      AutoscaledCapacityOptions {
    /**
     * The maximum allowable capacity.
     */
    override fun maxCapacity(): Number = unwrap(this).getMaxCapacity()

    /**
     * The minimum allowable capacity.
     *
     * Default: 1
     */
    override fun minCapacity(): Number? = unwrap(this).getMinCapacity()

    /**
     * If you want to switch a table's billing mode from on-demand to provisioned or from
     * provisioned to on-demand, you must specify a value for this property for each autoscaled
     * resource.
     *
     * Default: no seed capacity
     */
    override fun seedCapacity(): Number? = unwrap(this).getSeedCapacity()

    /**
     * The ratio of consumed capacity units to provisioned capacity units.
     *
     * Note: Target utilization percent cannot be less than 20 and cannot be greater
     * than 90.
     *
     * Default: 70
     */
    override fun targetUtilizationPercent(): Number? = unwrap(this).getTargetUtilizationPercent()
  }

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

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

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