Interface CfnRoute.HttpRetryPolicyProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnRoute.HttpRetryPolicyProperty extends
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 .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 HttpRetryPolicyProperty httpRetryPolicyProperty = HttpRetryPolicyProperty.builder()
         // the properties below are optional
  • Method Details

    • getMaxRetries

      @Stability(Stable) @NotNull Number getMaxRetries()
      The maximum number of retry attempts.
    • getPerRetryTimeout

      @Stability(Stable) @NotNull Object getPerRetryTimeout()
      The timeout for each retry attempt.
    • getHttpRetryEvents

      @Stability(Stable) @Nullable default List<String> getHttpRetryEvents()
      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
    • getTcpRetryEvents

      @Stability(Stable) @Nullable default List<String> getTcpRetryEvents()
      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.

    • builder

      @Stability(Stable) static CfnRoute.HttpRetryPolicyProperty.Builder builder()
      a CfnRoute.HttpRetryPolicyProperty.Builder of CfnRoute.HttpRetryPolicyProperty