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.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Note:

When making an API call, you may pass RoutingStrategy data as a hash:

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

The routing configuration for a fleet alias.

Related actions

CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#fleet_idString

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

Returns:

  • (String)


7970
7971
7972
7973
7974
7975
7976
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7970

class RoutingStrategy < Struct.new(
  :type,
  :fleet_id,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#messageString

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

Returns:

  • (String)


7970
7971
7972
7973
7974
7975
7976
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7970

class RoutingStrategy < Struct.new(
  :type,
  :fleet_id,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String)


7970
7971
7972
7973
7974
7975
7976
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7970

class RoutingStrategy < Struct.new(
  :type,
  :fleet_id,
  :message)
  SENSITIVE = []
  include Aws::Structure
end