Class: Aws::AppMesh::Types::HttpRetryPolicy

Inherits:

Struct

• Object
• Struct
• Aws::AppMesh::Types::HttpRetryPolicy

Defined in:

gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb

Overview

Note:

When making an API call, you may pass HttpRetryPolicy data as a hash:

{
  http_retry_events: ["HttpRetryPolicyEvent"],
  max_retries: 1, # required
  per_retry_timeout: { # required
    unit: "s", # accepts s, ms
    value: 1,
  },
  tcp_retry_events: ["connection-error"], # accepts connection-error
}

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #http_retry_events ⇒ Array<String>

  Specify at least one of the following values.

• #max_retries ⇒ Integer

  The maximum number of retry attempts.

• #per_retry_timeout ⇒ Types::Duration

  The timeout for each retry attempt.

• #tcp_retry_events ⇒ Array<String>

  Specify a valid value.

Instance Attribute Details

#http_retry_events ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4199

class HttpRetryPolicy < Struct.new(
  :http_retry_events,
  :max_retries,
  :per_retry_timeout,
  :tcp_retry_events)
  SENSITIVE = []
  include Aws::Structure
end

#max_retries ⇒ Integer

The maximum number of retry attempts.

Returns:

• (Integer)

# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4199

class HttpRetryPolicy < Struct.new(
  :http_retry_events,
  :max_retries,
  :per_retry_timeout,
  :tcp_retry_events)
  SENSITIVE = []
  include Aws::Structure
end

#per_retry_timeout ⇒ Types::Duration

The timeout for each retry attempt.

Returns:

• (Types::Duration)

# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4199

class HttpRetryPolicy < Struct.new(
  :http_retry_events,
  :max_retries,
  :per_retry_timeout,
  :tcp_retry_events)
  SENSITIVE = []
  include Aws::Structure
end

#tcp_retry_events ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4199

class HttpRetryPolicy < Struct.new(
  :http_retry_events,
  :max_retries,
  :per_retry_timeout,
  :tcp_retry_events)
  SENSITIVE = []
  include Aws::Structure
end