GrpcRetryPolicy
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
Contents
- maxRetries
-
The maximum number of retry attempts.
Type: Long
Valid Range: Minimum value of 0.
Required: Yes
- perRetryTimeout
-
The timeout for each retry attempt.
Type: Duration object
Required: Yes
- grpcRetryEvents
-
Specify at least one of the valid values.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Valid Values:
cancelled | deadline-exceeded | internal | resource-exhausted | unavailableRequired: No
- 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
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 25.
Required: No
-
- 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.
Type: Array of strings
Array Members: Fixed number of 1 item.
Valid Values:
connection-errorRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
