Class CfnRoute.GrpcRetryPolicyProperty

An object that represents a retry policy.

Inheritance

object

CfnRoute.GrpcRetryPolicyProperty

Implements

CfnRoute.IGrpcRetryPolicyProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AppMesh

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnRoute.GrpcRetryPolicyProperty : CfnRoute.IGrpcRetryPolicyProperty

Syntax (vb)

Public Class CfnRoute.GrpcRetryPolicyProperty Implements CfnRoute.IGrpcRetryPolicyProperty

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppMesh;

             var grpcRetryPolicyProperty = new GrpcRetryPolicyProperty {
                 MaxRetries = 123,
                 PerRetryTimeout = new DurationProperty {
                     Unit = "unit",
                     Value = 123
                 },

                 // the properties below are optional
                 GrpcRetryEvents = new [] { "grpcRetryEvents" },
                 HttpRetryEvents = new [] { "httpRetryEvents" },
                 TcpRetryEvents = new [] { "tcpRetryEvents" }
             };

Synopsis

Constructors

GrpcRetryPolicyProperty()

An object that represents a retry policy.

Properties

GrpcRetryEvents	Specify at least one of the valid values.
HttpRetryEvents	Specify at least one of the following values.
MaxRetries	The maximum number of retry attempts.
PerRetryTimeout	The timeout for each retry attempt.
TcpRetryEvents	Specify a valid value.

Constructors

GrpcRetryPolicyProperty()

An object that represents a retry policy.

public GrpcRetryPolicyProperty()

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppMesh;

             var grpcRetryPolicyProperty = new GrpcRetryPolicyProperty {
                 MaxRetries = 123,
                 PerRetryTimeout = new DurationProperty {
                     Unit = "unit",
                     Value = 123
                 },

                 // the properties below are optional
                 GrpcRetryEvents = new [] { "grpcRetryEvents" },
                 HttpRetryEvents = new [] { "httpRetryEvents" },
                 TcpRetryEvents = new [] { "tcpRetryEvents" }
             };

Properties

GrpcRetryEvents

Specify at least one of the valid values.

public string[]? GrpcRetryEvents { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-grpcretryevents

HttpRetryEvents

Specify at least one of the following values.

public string[]? HttpRetryEvents { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-httpretryevents

MaxRetries

The maximum number of retry attempts.

public double MaxRetries { get; set; }

Property Value

double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-maxretries

PerRetryTimeout

The timeout for each retry attempt.

public object PerRetryTimeout { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-perretrytimeout

TcpRetryEvents

Specify a valid value.

public string[]? TcpRetryEvents { get; set; }

Property Value

string[]

Remarks

The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-tcpretryevents

Implements

CfnRoute.IGrpcRetryPolicyProperty