RoutingStrategy - Amazon GameLift

RoutingStrategy

The routing configuration for a fleet alias.

Related actions

All APIs by task

Contents

Note

In the following list, the required parameters are described first.

FleetId

A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.

Type: String

Pattern: ^fleet-\S+

Required: No

Message

The message text to be used with a terminal routing strategy.

Type: String

Required: No

Type

The type of routing strategy for the alias.

Possible routing types include the following:

  • SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.

Type: String

Valid Values: SIMPLE | TERMINAL

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: