Amazonka.AppMesh.Types.HttpRetryPolicy

Documentation

data HttpRetryPolicy

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: newHttpRetryPolicy smart constructor.

Constructors

HttpRetryPolicy'

Fields

• httpRetryEvents :: Maybe (NonEmpty Text)

  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 :: Maybe (NonEmpty TcpRetryPolicyEvent)

  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.

• maxRetries :: Natural

  The maximum number of retry attempts.

• perRetryTimeout :: Duration

  The timeout for each retry attempt.

Instances

FromJSON HttpRetryPolicy

Defined in Amazonka.AppMesh.Types.HttpRetryPolicy

Methods

parseJSON :: Value -> Parser HttpRetryPolicy

parseJSONList :: Value -> Parser [HttpRetryPolicy]

ToJSON HttpRetryPolicy

Defined in Amazonka.AppMesh.Types.HttpRetryPolicy

Methods

toJSON :: HttpRetryPolicy -> Value

toEncoding :: HttpRetryPolicy -> Encoding

toJSONList :: [HttpRetryPolicy] -> Value

toEncodingList :: [HttpRetryPolicy] -> Encoding

Generic HttpRetryPolicy

Defined in Amazonka.AppMesh.Types.HttpRetryPolicy

Associated Types

type Rep HttpRetryPolicy :: Type -> Type

Methods

from :: HttpRetryPolicy -> Rep HttpRetryPolicy x

to :: Rep HttpRetryPolicy x -> HttpRetryPolicy

Read HttpRetryPolicy

Defined in Amazonka.AppMesh.Types.HttpRetryPolicy

Methods

readsPrec :: Int -> ReadS HttpRetryPolicy

readList :: ReadS [HttpRetryPolicy]

readPrec :: ReadPrec HttpRetryPolicy

readListPrec :: ReadPrec [HttpRetryPolicy]

Show HttpRetryPolicy

Defined in Amazonka.AppMesh.Types.HttpRetryPolicy

Methods

showsPrec :: Int -> HttpRetryPolicy -> ShowS

show :: HttpRetryPolicy -> String

showList :: [HttpRetryPolicy] -> ShowS

NFData HttpRetryPolicy

Defined in Amazonka.AppMesh.Types.HttpRetryPolicy

Methods

rnf :: HttpRetryPolicy -> ()

Eq HttpRetryPolicy

Defined in Amazonka.AppMesh.Types.HttpRetryPolicy

Methods

(==) :: HttpRetryPolicy -> HttpRetryPolicy -> Bool

(/=) :: HttpRetryPolicy -> HttpRetryPolicy -> Bool

Hashable HttpRetryPolicy

Defined in Amazonka.AppMesh.Types.HttpRetryPolicy

Methods

hashWithSalt :: Int -> HttpRetryPolicy -> Int

hash :: HttpRetryPolicy -> Int

type Rep HttpRetryPolicy

Defined in Amazonka.AppMesh.Types.HttpRetryPolicy

type Rep HttpRetryPolicy = D1 ('MetaData "HttpRetryPolicy" "Amazonka.AppMesh.Types.HttpRetryPolicy" "amazonka-appmesh-2.0-GBIHUgXnP8s1LEJyvNe1ca" 'False) (C1 ('MetaCons "HttpRetryPolicy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpRetryEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "tcpRetryEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty TcpRetryPolicyEvent)))) :*: (S1 ('MetaSel ('Just "maxRetries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "perRetryTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Duration))))

newHttpRetryPolicy

Arguments

:: Natural

$sel:maxRetries:HttpRetryPolicy'

-> Duration

$sel:perRetryTimeout:HttpRetryPolicy'

-> HttpRetryPolicy

Create a value of HttpRetryPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpRetryEvents:HttpRetryPolicy', httpRetryPolicy_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

$sel:tcpRetryEvents:HttpRetryPolicy', httpRetryPolicy_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.

$sel:maxRetries:HttpRetryPolicy', httpRetryPolicy_maxRetries - The maximum number of retry attempts.

$sel:perRetryTimeout:HttpRetryPolicy', httpRetryPolicy_perRetryTimeout - The timeout for each retry attempt.

httpRetryPolicy_httpRetryEvents :: Lens' HttpRetryPolicy (Maybe (NonEmpty Text))

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

httpRetryPolicy_tcpRetryEvents :: Lens' HttpRetryPolicy (Maybe (NonEmpty TcpRetryPolicyEvent))

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.

httpRetryPolicy_maxRetries :: Lens' HttpRetryPolicy Natural

The maximum number of retry attempts.

httpRetryPolicy_perRetryTimeout :: Lens' HttpRetryPolicy Duration

The timeout for each retry attempt.