io.cloudshiftdev.awscdk.services.ecs.DeploymentAlarmConfig.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.ecs

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

/**
 * Configuration for deployment alarms.
 *
 * Example:
 *
 * ```
 * import io.cloudshiftdev.awscdk.services.cloudwatch.*;
 * Cluster cluster;
 * TaskDefinition taskDefinition;
 * Alarm elbAlarm;
 * FargateService service = FargateService.Builder.create(this, "Service")
 * .cluster(cluster)
 * .taskDefinition(taskDefinition)
 * .deploymentAlarms(DeploymentAlarmConfig.builder()
 * .alarmNames(List.of(elbAlarm.getAlarmName()))
 * .behavior(AlarmBehavior.ROLLBACK_ON_ALARM)
 * .build())
 * .build();
 * // Defining a deployment alarm after the service has been created
 * String cpuAlarmName = "MyCpuMetricAlarm";
 * Alarm.Builder.create(this, "CPUAlarm")
 * .alarmName(cpuAlarmName)
 * .metric(service.metricCpuUtilization())
 * .evaluationPeriods(2)
 * .threshold(80)
 * .build();
 * service.enableDeploymentAlarms(List.of(cpuAlarmName), DeploymentAlarmOptions.builder()
 * .behavior(AlarmBehavior.FAIL_ON_ALARM)
 * .build());
 * ```
 */
public interface DeploymentAlarmConfig : DeploymentAlarmOptions {
  /**
   * List of alarm names to monitor during deployments.
   */
  public fun alarmNames(): List

  /**
   * A builder for [DeploymentAlarmConfig]
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * @param alarmNames List of alarm names to monitor during deployments. 
     */
    public fun alarmNames(alarmNames: List)

    /**
     * @param alarmNames List of alarm names to monitor during deployments. 
     */
    public fun alarmNames(vararg alarmNames: String)

    /**
     * @param behavior Default rollback on alarm.
     */
    public fun behavior(behavior: AlarmBehavior)
  }

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

    /**
     * @param alarmNames List of alarm names to monitor during deployments. 
     */
    override fun alarmNames(alarmNames: List) {
      cdkBuilder.alarmNames(alarmNames)
    }

    /**
     * @param alarmNames List of alarm names to monitor during deployments. 
     */
    override fun alarmNames(vararg alarmNames: String): Unit = alarmNames(alarmNames.toList())

    /**
     * @param behavior Default rollback on alarm.
     */
    override fun behavior(behavior: AlarmBehavior) {
      cdkBuilder.behavior(behavior.let(AlarmBehavior.Companion::unwrap))
    }

    public fun build(): software.amazon.awscdk.services.ecs.DeploymentAlarmConfig =
        cdkBuilder.build()
  }

  private class Wrapper(
    cdkObject: software.amazon.awscdk.services.ecs.DeploymentAlarmConfig,
  ) : CdkObject(cdkObject),
      DeploymentAlarmConfig {
    /**
     * List of alarm names to monitor during deployments.
     */
    override fun alarmNames(): List = unwrap(this).getAlarmNames()

    /**
     * Default rollback on alarm.
     *
     * Default: AlarmBehavior.ROLLBACK_ON_ALARM
     */
    override fun behavior(): AlarmBehavior? = unwrap(this).getBehavior()?.let(AlarmBehavior::wrap)
  }

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

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

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