All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.cloudshiftdev.awscdk.services.appmesh.OutlierDetection.kt Maven / Gradle / Ivy

The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package io.cloudshiftdev.awscdk.services.appmesh

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

/**
 * Represents the outlier detection for a listener.
 *
 * Example:
 *
 * ```
 * Mesh mesh;
 * // Cloud Map service discovery is currently required for host ejection by outlier detection
 * Vpc vpc = new Vpc(this, "vpc");
 * PrivateDnsNamespace namespace = PrivateDnsNamespace.Builder.create(this, "test-namespace")
 * .vpc(vpc)
 * .name("domain.local")
 * .build();
 * Service service = namespace.createService("Svc");
 * VirtualNode node = mesh.addVirtualNode("virtual-node", VirtualNodeBaseProps.builder()
 * .serviceDiscovery(ServiceDiscovery.cloudMap(service))
 * .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder()
 * .outlierDetection(OutlierDetection.builder()
 * .baseEjectionDuration(Duration.seconds(10))
 * .interval(Duration.seconds(30))
 * .maxEjectionPercent(50)
 * .maxServerErrors(5)
 * .build())
 * .build())))
 * .build());
 * ```
 */
public interface OutlierDetection {
  /**
   * The base amount of time for which a host is ejected.
   */
  public fun baseEjectionDuration(): Duration

  /**
   * The time interval between ejection sweep analysis.
   */
  public fun interval(): Duration

  /**
   * Maximum percentage of hosts in load balancing pool for upstream service that can be ejected.
   *
   * Will eject at
   * least one host regardless of the value.
   */
  public fun maxEjectionPercent(): Number

  /**
   * Number of consecutive 5xx errors required for ejection.
   */
  public fun maxServerErrors(): Number

  /**
   * A builder for [OutlierDetection]
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * @param baseEjectionDuration The base amount of time for which a host is ejected. 
     */
    public fun baseEjectionDuration(baseEjectionDuration: Duration)

    /**
     * @param interval The time interval between ejection sweep analysis. 
     */
    public fun interval(interval: Duration)

    /**
     * @param maxEjectionPercent Maximum percentage of hosts in load balancing pool for upstream
     * service that can be ejected. 
     * Will eject at
     * least one host regardless of the value.
     */
    public fun maxEjectionPercent(maxEjectionPercent: Number)

    /**
     * @param maxServerErrors Number of consecutive 5xx errors required for ejection. 
     */
    public fun maxServerErrors(maxServerErrors: Number)
  }

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

    /**
     * @param baseEjectionDuration The base amount of time for which a host is ejected. 
     */
    override fun baseEjectionDuration(baseEjectionDuration: Duration) {
      cdkBuilder.baseEjectionDuration(baseEjectionDuration.let(Duration.Companion::unwrap))
    }

    /**
     * @param interval The time interval between ejection sweep analysis. 
     */
    override fun interval(interval: Duration) {
      cdkBuilder.interval(interval.let(Duration.Companion::unwrap))
    }

    /**
     * @param maxEjectionPercent Maximum percentage of hosts in load balancing pool for upstream
     * service that can be ejected. 
     * Will eject at
     * least one host regardless of the value.
     */
    override fun maxEjectionPercent(maxEjectionPercent: Number) {
      cdkBuilder.maxEjectionPercent(maxEjectionPercent)
    }

    /**
     * @param maxServerErrors Number of consecutive 5xx errors required for ejection. 
     */
    override fun maxServerErrors(maxServerErrors: Number) {
      cdkBuilder.maxServerErrors(maxServerErrors)
    }

    public fun build(): software.amazon.awscdk.services.appmesh.OutlierDetection =
        cdkBuilder.build()
  }

  private class Wrapper(
    cdkObject: software.amazon.awscdk.services.appmesh.OutlierDetection,
  ) : CdkObject(cdkObject),
      OutlierDetection {
    /**
     * The base amount of time for which a host is ejected.
     */
    override fun baseEjectionDuration(): Duration =
        unwrap(this).getBaseEjectionDuration().let(Duration::wrap)

    /**
     * The time interval between ejection sweep analysis.
     */
    override fun interval(): Duration = unwrap(this).getInterval().let(Duration::wrap)

    /**
     * Maximum percentage of hosts in load balancing pool for upstream service that can be ejected.
     *
     * Will eject at
     * least one host regardless of the value.
     */
    override fun maxEjectionPercent(): Number = unwrap(this).getMaxEjectionPercent()

    /**
     * Number of consecutive 5xx errors required for ejection.
     */
    override fun maxServerErrors(): Number = unwrap(this).getMaxServerErrors()
  }

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

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

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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy