View a markdown version of this page

AWS::BedrockAgentCore::GatewayRule FallbackTriggers - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::BedrockAgentCore::GatewayRule FallbackTriggers

The conditions that trigger a fallback to the next target. A fallback occurs if the response matches any of the specified status codes or errors.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Errors" : [ String, ... ],
  "StatusCodes" : [ String, ... ]
}

YAML

  Errors: 
    - String
  StatusCodes: 
    - String

Properties

Errors

The errors that trigger a fallback. You can specify the following:

  • CONNECTION_ERROR – The gateway couldn't connect to the target because the connection was refused, reset, or timed out. The request didn't reach the target.

  • FIRST_BYTE_TIMEOUT – The target accepted the connection but didn't return the first byte of the response within firstByteTimeoutMilliseconds. The gateway abandons the request before any of the response reaches you.

  • UNROUTABLE – The gateway couldn't route the request to the target, for example because the target doesn't exist or doesn't support the request path. These errors don't count toward the circuit breaker.

Required: No

Type: Array of String

Minimum: 1

Maximum: 3

Update requires: No interruption

StatusCodes

The HTTP status codes returned by the target that trigger a fallback. You can specify the following:

  • An exact status code – A three-digit code, such as 429.

  • A class of status codes – The first digit followed by XX, such as 5XX, which matches every code from 500 to 599.

Only 4XX and 5XX codes are supported. Throttling by the gateway itself doesn't trigger a fallback.

Required: No

Type: Array of String

Minimum: 1

Maximum: 10

Update requires: No interruption