interface GrpcRetryPolicyProperty

Language	Type name
.NET	`Amazon.CDK.AWS.AppMesh.CfnRoute.GrpcRetryPolicyProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#CfnRoute_GrpcRetryPolicyProperty`
Java	`software.amazon.awscdk.services.appmesh.CfnRoute.GrpcRetryPolicyProperty`
Python	`aws_cdk.aws_appmesh.CfnRoute.GrpcRetryPolicyProperty`
TypeScript	`aws-cdk-lib` » `aws_appmesh` » `CfnRoute` » `GrpcRetryPolicyProperty`

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 { aws_appmesh as appmesh } from 'aws-cdk-lib';
const grpcRetryPolicyProperty: appmesh.CfnRoute.GrpcRetryPolicyProperty = {
  maxRetries: 123,
  perRetryTimeout: {
    unit: 'unit',
    value: 123,
  },

  // the properties below are optional
  grpcRetryEvents: ['grpcRetryEvents'],
  httpRetryEvents: ['httpRetryEvents'],
  tcpRetryEvents: ['tcpRetryEvents'],
};

Properties

Name	Type	Description
maxRetries	`number`	The maximum number of retry attempts.
perRetryTimeout	`IResolvable` `\|` `DurationProperty`	The timeout for each retry attempt.
grpcRetryEvents?	`string[]`	Specify at least one of the valid values.
httpRetryEvents?	`string[]`	Specify at least one of the following values.
tcpRetryEvents?	`string[]`	Specify a valid value.

maxRetries

Type: number

The maximum number of retry attempts.

perRetryTimeout

Type: IResolvable | DurationProperty

The timeout for each retry attempt.

grpcRetryEvents?

Type: string[] (optional)

Specify at least one of the valid values.

httpRetryEvents?

Type: string[] (optional)

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

tcpRetryEvents?

Type: string[] (optional)

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.