software.amazon.awscdk.services.appmesh

Interface CfnRoute.HttpRetryPolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRoute.HttpRetryPolicyProperty.Jsii$Proxy

Enclosing class:

CfnRoute

@Stability(value=Stable)
public static interface CfnRoute.HttpRetryPolicyProperty
extends software.amazon.jsii.JsiiSerializable

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 .

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnRoute.HttpRetryPolicyProperty.Builder A builder for CfnRoute.HttpRetryPolicyProperty
static class	CfnRoute.HttpRetryPolicyProperty.Jsii$Proxy An implementation for CfnRoute.HttpRetryPolicyProperty

Method Summary

Modifier and Type	Method and Description
static CfnRoute.HttpRetryPolicyProperty.Builder	builder()
default List<String>	getHttpRetryEvents() Specify at least one of the following values.
Number	getMaxRetries() The maximum number of retry attempts.
Object	getPerRetryTimeout() The timeout for each retry attempt.
default List<String>	getTcpRetryEvents() Specify a valid value.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMaxRetries

@Stability(value=Stable)
 @NotNull
Number getMaxRetries()

The maximum number of retry attempts.

getPerRetryTimeout

@Stability(value=Stable)
 @NotNull
Object getPerRetryTimeout()

The timeout for each retry attempt.

getHttpRetryEvents

@Stability(value=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(value=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(value=Stable)
static CfnRoute.HttpRetryPolicyProperty.Builder builder()

Returns:

a CfnRoute.HttpRetryPolicyProperty.Builder of CfnRoute.HttpRetryPolicyProperty