Skip to content

RoutingStrategy

Used by
Source code in docs_src/capo_gamelift/types/routing_strategy.py 
13
14
15
16
17
18
19
class RoutingStrategy(TypedDict, closed=True):
    type: NotRequired["capo_gamelift.types.routing_strategy_type.RoutingStrategyType"]
    """<p>The type of routing strategy for the alias.</p> <p>Possible routing types include the following:</p> <ul> <li> <p> <b>SIMPLE</b> - The alias resolves to one specific fleet. Use this type when routing to active fleets.</p> </li> <li> <p> <b>TERMINAL</b> - 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.</p> </li> </ul>"""
    fleet_id: NotRequired["capo_gamelift.types.fleet_id.FleetId"]
    """<p>A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.</p>"""
    message: NotRequired["capo_gamelift.types.free_text.FreeText"]
    """<p>The message text to be used with a terminal routing strategy.</p>"""

fleet_id instance-attribute 

fleet_id: NotRequired[FleetId]

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

message instance-attribute 

message: NotRequired[FreeText]

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

type instance-attribute 

type: NotRequired[RoutingStrategyType]

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.