AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::RoutingStrategy

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RoutingStrategy as input to an Aws::Client method, you can use a vanilla Hash:

{
  type: "SIMPLE", # accepts SIMPLE, TERMINAL
  fleet_id: "FleetId",
  message: "FreeText",
}

The routing configuration for a fleet alias.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#fleet_idString

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

Returns:

  • (String)

    The unique identifier for a fleet that the alias points to.

#messageString

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

Returns:

  • (String)

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

#typeString

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 RoutingStrategy message embedded.

    Possible values:

    • SIMPLE
    • TERMINAL

Returns:

  • (String)

    The type of routing strategy for the alias.