io.cloudshiftdev.awscdk.services.cloudwatch.MetricExpressionConfig.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.cloudwatch

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

/**
 * Properties for a concrete metric.
 *
 * Example:
 *
 * ```
 * // The code below shows an example of how to instantiate this type.
 * // The values are placeholders you should change.
 * import io.cloudshiftdev.awscdk.services.cloudwatch.*;
 * Metric metric;
 * MetricExpressionConfig metricExpressionConfig = MetricExpressionConfig.builder()
 * .expression("expression")
 * .period(123)
 * .usingMetrics(Map.of(
 * "usingMetricsKey", metric))
 * // the properties below are optional
 * .searchAccount("searchAccount")
 * .searchRegion("searchRegion")
 * .build();
 * ```
 */
public interface MetricExpressionConfig {
  /**
   * Math expression for the metric.
   */
  public fun expression(): String

  /**
   * How many seconds to aggregate over.
   */
  public fun period(): Number

  /**
   * Account to evaluate search expressions within.
   *
   * Default: - Deployment account.
   */
  public fun searchAccount(): String? = unwrap(this).getSearchAccount()

  /**
   * Region to evaluate search expressions within.
   *
   * Default: - Deployment region.
   */
  public fun searchRegion(): String? = unwrap(this).getSearchRegion()

  /**
   * Metrics used in the math expression.
   */
  public fun usingMetrics(): Map

  /**
   * A builder for [MetricExpressionConfig]
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * @param expression Math expression for the metric. 
     */
    public fun expression(expression: String)

    /**
     * @param period How many seconds to aggregate over. 
     */
    public fun period(period: Number)

    /**
     * @param searchAccount Account to evaluate search expressions within.
     */
    public fun searchAccount(searchAccount: String)

    /**
     * @param searchRegion Region to evaluate search expressions within.
     */
    public fun searchRegion(searchRegion: String)

    /**
     * @param usingMetrics Metrics used in the math expression. 
     */
    public fun usingMetrics(usingMetrics: Map)
  }

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

    /**
     * @param expression Math expression for the metric. 
     */
    override fun expression(expression: String) {
      cdkBuilder.expression(expression)
    }

    /**
     * @param period How many seconds to aggregate over. 
     */
    override fun period(period: Number) {
      cdkBuilder.period(period)
    }

    /**
     * @param searchAccount Account to evaluate search expressions within.
     */
    override fun searchAccount(searchAccount: String) {
      cdkBuilder.searchAccount(searchAccount)
    }

    /**
     * @param searchRegion Region to evaluate search expressions within.
     */
    override fun searchRegion(searchRegion: String) {
      cdkBuilder.searchRegion(searchRegion)
    }

    /**
     * @param usingMetrics Metrics used in the math expression. 
     */
    override fun usingMetrics(usingMetrics: Map) {
      cdkBuilder.usingMetrics(usingMetrics.mapValues{IMetric.unwrap(it.value)})
    }

    public fun build(): software.amazon.awscdk.services.cloudwatch.MetricExpressionConfig =
        cdkBuilder.build()
  }

  private class Wrapper(
    cdkObject: software.amazon.awscdk.services.cloudwatch.MetricExpressionConfig,
  ) : CdkObject(cdkObject),
      MetricExpressionConfig {
    /**
     * Math expression for the metric.
     */
    override fun expression(): String = unwrap(this).getExpression()

    /**
     * How many seconds to aggregate over.
     */
    override fun period(): Number = unwrap(this).getPeriod()

    /**
     * Account to evaluate search expressions within.
     *
     * Default: - Deployment account.
     */
    override fun searchAccount(): String? = unwrap(this).getSearchAccount()

    /**
     * Region to evaluate search expressions within.
     *
     * Default: - Deployment region.
     */
    override fun searchRegion(): String? = unwrap(this).getSearchRegion()

    /**
     * Metrics used in the math expression.
     */
    override fun usingMetrics(): Map =
        unwrap(this).getUsingMetrics().mapValues{IMetric.wrap(it.value)}
  }

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

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

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