cloudshift.awscdk.dsl.services.appmesh.CfnRouteHttpRetryPolicyPropertyDsl.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dsl Show documentation
Kotlin DSL for AWS CDK
There is a newer version: 0.7.0
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package cloudshift.awscdk.dsl.services.appmesh

import cloudshift.awscdk.common.CdkDslMarker
import kotlin.Number
import kotlin.String
import kotlin.collections.Collection
import kotlin.collections.MutableList
import software.amazon.awscdk.IResolvable
import software.amazon.awscdk.services.appmesh.CfnRoute

/**
 * An object that represents a retry policy.
 *
 * Specify at least one value for at least one of the types of `RetryEvents` , a value for
 * `maxRetries` , and a value for `perRetryTimeout` . Both `server-error` and `gateway-error` under
 * `httpRetryEvents` include the Envoy `reset` policy. For more information on the `reset` policy, see
 * the [Envoy
 * documentation](https://docs.aws.amazon.com/https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-on)
 * .
 *
 * Example:
 *
 * ```
 * // The code below shows an example of how to instantiate this type.
 * // The values are placeholders you should change.
 * import software.amazon.awscdk.services.appmesh.*;
 * HttpRetryPolicyProperty httpRetryPolicyProperty = HttpRetryPolicyProperty.builder()
 * .maxRetries(123)
 * .perRetryTimeout(DurationProperty.builder()
 * .unit("unit")
 * .value(123)
 * .build())
 * // the properties below are optional
 * .httpRetryEvents(List.of("httpRetryEvents"))
 * .tcpRetryEvents(List.of("tcpRetryEvents"))
 * .build();
 * ```
 *
 * [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html)
 */
@CdkDslMarker
public class CfnRouteHttpRetryPolicyPropertyDsl {
  private val cdkBuilder: CfnRoute.HttpRetryPolicyProperty.Builder =
      CfnRoute.HttpRetryPolicyProperty.builder()

  private val _httpRetryEvents: MutableList = mutableListOf()

  private val _tcpRetryEvents: MutableList = mutableListOf()

  /**
   * @param httpRetryEvents Specify at least one of the following values.
   * * *server-error* – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
   * * *gateway-error* – HTTP status codes 502, 503, and 504
   * * *client-error* – HTTP status code 409
   * * *stream-error* – Retry on refused stream
   */
  public fun httpRetryEvents(vararg httpRetryEvents: String) {
    _httpRetryEvents.addAll(listOf(*httpRetryEvents))
  }

  /**
   * @param httpRetryEvents Specify at least one of the following values.
   * * *server-error* – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
   * * *gateway-error* – HTTP status codes 502, 503, and 504
   * * *client-error* – HTTP status code 409
   * * *stream-error* – Retry on refused stream
   */
  public fun httpRetryEvents(httpRetryEvents: Collection) {
    _httpRetryEvents.addAll(httpRetryEvents)
  }

  /**
   * @param maxRetries The maximum number of retry attempts. 
   */
  public fun maxRetries(maxRetries: Number) {
    cdkBuilder.maxRetries(maxRetries)
  }

  /**
   * @param perRetryTimeout The timeout for each retry attempt. 
   */
  public fun perRetryTimeout(perRetryTimeout: IResolvable) {
    cdkBuilder.perRetryTimeout(perRetryTimeout)
  }

  /**
   * @param perRetryTimeout The timeout for each retry attempt. 
   */
  public fun perRetryTimeout(perRetryTimeout: CfnRoute.DurationProperty) {
    cdkBuilder.perRetryTimeout(perRetryTimeout)
  }

  /**
   * @param tcpRetryEvents Specify a valid value.
   * The event occurs before any processing of a request has started and is encountered when the
   * upstream is temporarily or permanently unavailable.
   */
  public fun tcpRetryEvents(vararg tcpRetryEvents: String) {
    _tcpRetryEvents.addAll(listOf(*tcpRetryEvents))
  }

  /**
   * @param tcpRetryEvents Specify a valid value.
   * The event occurs before any processing of a request has started and is encountered when the
   * upstream is temporarily or permanently unavailable.
   */
  public fun tcpRetryEvents(tcpRetryEvents: Collection) {
    _tcpRetryEvents.addAll(tcpRetryEvents)
  }

  public fun build(): CfnRoute.HttpRetryPolicyProperty {
    if(_httpRetryEvents.isNotEmpty()) cdkBuilder.httpRetryEvents(_httpRetryEvents)
    if(_tcpRetryEvents.isNotEmpty()) cdkBuilder.tcpRetryEvents(_tcpRetryEvents)
    return cdkBuilder.build()
  }
}